Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Link to end-user manual #436

Closed
nichtich opened this issue Jun 28, 2019 · 3 comments
Closed

Link to end-user manual #436

nichtich opened this issue Jun 28, 2019 · 3 comments
Labels
documentation Provide sufficient documentation
Milestone

Comments

@nichtich
Copy link
Member

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.

@nichtich nichtich added the documentation Provide sufficient documentation label Jun 28, 2019
@nichtich nichtich added this to the 1.0.0 milestone Jun 28, 2019
@stefandesu
Copy link
Member

stefandesu commented Jun 28, 2019

  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
Copy link
Member Author

nichtich commented Jul 1, 2019

  • Link to user-manual from README
  • Link to user-manual from "Help" menu item (replace with hard-coded "Anleitung" / "Manual")
  • extend user-manual to include build time and version number
  • Fix link from the welcome page

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

@nichtich
Copy link
Member Author

nichtich commented Jul 1, 2019

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Provide sufficient documentation
Projects
None yet
Development

No branches or pull requests

2 participants