Skip to content

Update QuickStart contents #121

@jodygarnett

Description

@jodygarnett

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:

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions