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

Update QuickStart contents #121

Open
8 tasks
jodygarnett opened this issue Jan 29, 2020 · 0 comments
Open
8 tasks

Update QuickStart contents #121

jodygarnett opened this issue Jan 29, 2020 · 0 comments

Comments

@jodygarnett
Copy link
Contributor

jodygarnett commented Jan 29, 2020

Going to make a checklist so we can collect many small feedbacks :)

quickstart:

  • assumes installation and/or docker available

    • "after going through installer steps" ... install instructions under "maintainer guide" is appropriate? No that page is empty...
    • "when you use docker" - but no docker instructions are anywhere to be found

    Indeed this quickstart page is the top pick when searching for docker instructions for geonetwork.

  • Recommend: include install instructions here, no discussion of trade-offs like maintainer section, just step by step instructions installation

  • installer quickstart page, step by step instructions from download to running start.bat

  • tomcat quickstart page (replacing a war install instructions)

  • docker quickstart page (recommend: Include docker instructions, or link to them)

Recommendation:

  • Adopt a numbered step approach or template
  • Break into individual pages?
  • Adopt consistent RST syntax to avoid basic markup, and make use of directives (see Sphinx RST Style guide )

See:

@jodygarnett jodygarnett changed the title QuickStart starts assumes installation and/or docker available Update QuickStart contents Jan 30, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant