#59 Help docs showing wrong version number

Closed
opened 11 months ago by jhabdas · 1 comments

Installation script currently places help docs in the site and data from npm to site/data/theme/latest.json. When the help script is then run:

./theme/after-dark/bin/help

It deletes the current help doc and regenerates it from scratch using the data in latest.json stored in the site, but does not update latest.json

This presents two problems:

  1. The latest.json at the site may not correspond to the latest version installed.
  2. Scripts provided by the theme do not and should never attempt to rm in site.

To resolve this we need to:

  • Move latest.json into the theme’s data folder (requires path change)
  • Update the help doc archetype to use the new path
  • Update the install script to place the latest.json into the correct folder
  • Create an upgrade script to automatically update the theme and latest.json
  • Enhance help script to respect contentDir setting in config.toml
Installation script currently places help docs in the site and data from npm to `site/data/theme/latest.json`. When the `help` script is then run: ``` ./theme/after-dark/bin/help ``` It deletes the current help doc and regenerates it from scratch using the data in `latest.json` stored in the site, but does not update `latest.json` This presents two problems: 1. The `latest.json` at the site may not correspond to the latest version installed. 2. Scripts provided by the theme do not and should never attempt to `rm` in site. To resolve this we need to: - Move `latest.json` into the theme's data folder (requires path change) - Update the help doc archetype to use the new path - Update the install script to place the latest.json into the correct folder - Create an `upgrade` script to automatically update the theme and `latest.json` - Enhance `help` script to respect `contentDir` setting in `config.toml`
jhabdas added the
bug
label 11 months ago
jhabdas added the
enhancement
label 11 months ago
jhabdas commented 11 months ago
Owner

See 6415250769 for detailed help on getting the new help doc working if you’re on any older version of after dark.

See https://git.habd.as/comfusion/after-dark/commit/6415250769c9c78338893f98b5ab9b77968053f7 for detailed help on getting the new help doc working if you're on any older version of after dark.
Sign in to join this conversation.
No Milestone
No Assignees
1 Participants
Due Date

No due date set.

Dependencies

This issue currently doesn't have any dependencies.

Loading…
Cancel
Save
There is no content yet.