gbv / cocoda

A web-based tool for creating mappings between knowledge organization systems.
https://coli-conc.gbv.de/cocoda/
MIT License
39 stars 5 forks source link

Link to end-user manual #436

Closed nichtich closed 5 years ago

nichtich commented 5 years ago

npm run user-manual creates end-user manual in HTML but the HTML files are only copied to dist/ so they don't end up at http://coli-conc.gbv.de/cocoda/dev/user-manual-de.html, http://coli-conc.gbv.de/cocoda/dev/user-manual-en.html where they should. When this is fixed, the README and the Help link in menu bar should link to end-user-manual.

stefandesu commented 5 years ago
  1. For the manual to be accessible in dev, npm run user-manual must be added to the webhook that builds the dev.

  2. For the manual to be accessible in the build release on GitHub, npm run user-manual must be put after npm run build because dist is moved after that.

The question is whether this is really what we want. Wouldn't it be enough if the manual was accessible on GitHub Pages via https://gbv.github.io/cocoda/user-manual-de.html? In that case we'd need to change the Travis config as well because the file would need to be included in the styleguide folder.

Edit: An argument for having the manual right in the build would be that there might be changes to the manual that relate to changes in dev that are not yet pushed to master, so someone using the release instance might get confused by reading the (newer) manual from dev.

nichtich commented 5 years ago

At least the German manual should also be proofread and some screenshots can be updated.

nichtich commented 5 years ago

The date and version from build-info.json are included in the manual but they only show up when this file actually contains non null values.