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:

• Documentation Writing Guide

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

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

If you are using Python3:

1. Install using pip3 and build:

   pip3 install -r requirements.txt

   In the future you can update using:

   pip3 install -r requirements.txt -U 

2. Use *mkdocs to preview locally:

   mkdocs serve

3. Preview: http://localhost:8000

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

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

4. Optional: Preview online help:

   mkdocs serve --config-file help.yml  

If you use a Python virtual environment:

1. Activate virtual environment:

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

   In the future you can update with:

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

2. Use mkdocs to preview from virtual environment:

   mkdocs serve

3. Preview: http://localhost:8000

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

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

4. Optional: Preview online help:

   mkdocs serve --config-file help.yml  

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
   

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:

• https://squidfunk.github.io/mkdocs-material/setup/setting-up-versioning/
• https://github.com/squidfunk/mkdocs-material-example-versioning
• https://github.com/jimporter/mike