diff --git a/docs/manual/README.md b/docs/manual/README.md index 589b5f63451c..ab2a3676179b 100644 --- a/docs/manual/README.md +++ b/docs/manual/README.md @@ -12,6 +12,31 @@ Reference: The [project issue tracker](https://github.com/geonetwork/core-geonetwork/issues) is used for communication, with ongoing topics tagged [documentation](https://github.com/geonetwork/core-geonetwork/issues?q=is%3Aissue+label%3Adocumenation). + +## Maven Integration + +1. Build documentation with ``compile`` phase: + ``` + mvn compile + ``` + +2. Assemble ``zip`` with ``package`` phase: + ```bash + mvn compile + ``` + +3. Both ``install`` and ``deploy`` are skipped (so ``mvn clean install`` is fine). + +4. Use profile to include specific language: + ``` + mvn install -Pfrench + ``` + + Or flag for all of them: + ``` + mvn install -Dall + ``` + ## Material for MkDocs Documentation is [mkdocs-material](https://squidfunk.github.io/mkdocs-material/) which is a Markdown documentation framework written on top of [MkDocs](https://www.mkdocs.org/). diff --git a/docs/manual/mkdocs.yml b/docs/manual/mkdocs.yml index 0887ada7644f..30f0c8902c97 100644 --- a/docs/manual/mkdocs.yml +++ b/docs/manual/mkdocs.yml @@ -40,7 +40,6 @@ theme: plugins: - search - - offline - i18n: docs_structure: suffix languages: @@ -51,7 +50,7 @@ plugins: site_name: 'GeoNetwork (en)' - locale: fr name: Français - build: true + build: !ENV [FRENCH,false] site_name: 'GeoNetwork (fr)' nav_translations: Home: Home diff --git a/docs/manual/overrides/main.html b/docs/manual/overrides/main.html new file mode 100644 index 000000000000..920c039f9fde --- /dev/null +++ b/docs/manual/overrides/main.html @@ -0,0 +1,5 @@ +{% extends "base.html" %} + +{% block announce %} + Preview GeoNetwork documentation in mkdocs, feedback welcome on core-geonetwork#7286 +{% endblock %} diff --git a/docs/manual/pom.xml b/docs/manual/pom.xml index 3ae42f0f95b3..7e9a8eb03965 100644 --- a/docs/manual/pom.xml +++ b/docs/manual/pom.xml @@ -33,6 +33,9 @@ gn-guide GeoNetwork Guide pom + + false + Creative Commons Attribution 3.0 License @@ -55,7 +58,9 @@ + + @@ -98,4 +103,18 @@ + + + french + + + all + + + + true + + + + diff --git a/docs/manual/src/assembly/guide.xml b/docs/manual/src/assembly/guide.xml index 3d96f53796b4..157e4043f59a 100644 --- a/docs/manual/src/assembly/guide.xml +++ b/docs/manual/src/assembly/guide.xml @@ -6,6 +6,13 @@ target/html + + + **/*.rst + confy.py + anchors.txt + 404.html +