Skip to content

README.md

Latest commit

 

History

History
119 lines (77 loc) · 3 KB

README.md

File metadata and controls

119 lines (77 loc) · 3 KB

GeoNetwork Manual and Help

Documentation for GeoNetwork opensource is available via https://docs.geonetwork-opensource.org.

This documentation is written under the Creative Commons license Attribution-ShareAlike 3.0 Unported (CC BY-SA 3.0).

Reference:

Communication

The project issue tracker is used for communication, with ongoing topics tagged documentation.

Material for MkDocs

Documentation is MkDocs-material which is a Markdown documentation framework written on top of MkDocs.

  1. Install virtual environment:

    virtualenv venv

  2. Activate virtual environment and install (or update) requirements:

    source venv/bin/activate
pip install -r requirements.txt

  3. Use mkdocs to preview from virtual environment:

    mkdocs serve

  4. Preview: http://localhost:8000

    Preview uses a single version, so expect some warnings from version chooser:

    "GET /versions.json HTTP/1.1" code 404

  5. Optional: Preview online help:

    mkdocs serve --config-file help.yml

Maven Integration

  1. Build documentation with compile phase:

    mvn compile

  2. Assemble zip with package phase:

    mvn package

  3. Both install and deploy are skipped (so mvn clean install is fine).

  4. Use default profile to only build the default English docs:

    mvn install -Pdefault

Publish Documentation

We use mike for publishing (from the gh-pages branch). Docs are published by the .github/workflows/docs.yml automation each time pull-request is merged.

If you wish to preview using your own gh-pages branch:

  1. To deploy 4.4 docs as latest from the main branch to website gh-pages branch:

    mike deploy --title "4.4 Latest" --alias-type=copy --update-aliases 4.4 latest

  2. To deploy documentation for stable release:

    mike deploy --push --alias-type=copy 4.2 stable

  3. When starting a new branch you can make it the default:

    mike set-default --push 4.6

    Hint: When starting a new branch update overview/changelog/history/index.md headings for latest, maintenance, stable (for prior branches also).

  4. To publish documentation for a maintenance release:

    mike deploy --push --alias-type=copy 3.12 maintenance

  5. To show published versions:

    mike list

  6. To preview things locally (uses your local gh-pages branch):

    mike serve

Reference: