diff --git a/docs/manual/README.md b/docs/manual/README.md index 1aba8def34d3..d01313f1f474 100644 --- a/docs/manual/README.md +++ b/docs/manual/README.md @@ -23,6 +23,12 @@ If you are using Python3: ```bash pip3 install -r requirements.txt ``` + + In the future you can update using: + + ```bash + pip3 install -r requirements.txt -U + ``` 2. Use ***mkdocs** to preview locally: @@ -55,6 +61,13 @@ If you use a Python virtual environment: pip install -r requirements.txt ``` + In the future you can update with: + + ```bash + source venv/bin/activate + pip3 install -r requirements.txt + ``` + 2. Use ***mkdocs*** to preview from virtual environment: ```bash @@ -63,18 +76,16 @@ If you use a Python virtual environment: 3. Preview: http://localhost:8000 -### Docker - -If you are not familiar with Python the MkDocs-material website has instructions for Docker: - -1. Run MkDocs in Docker environment: - + Preview uses a single version, so expect some warnings from version chooser: ``` - docker pull squidfunk/mkdocs-material - docker run --rm -it -p 8000:8000 -v ${PWD}:/docs squidfunk/mkdocs-material + "GET /versions.json HTTP/1.1" code 404 ``` + +4. Optional: Preview online help: -2. Preview: http://localhost:8000 + ```bash + mkdocs serve --config-file help.yml + ``` ## Maven Integration @@ -108,7 +119,7 @@ If you wish to preview using your own `gh-pages` branch: mike deploy --title "4.4 Latest" --alias-type=copy --update-aliases 4.4 latest ``` -2. To deploy documentation for a new release: +2. To deploy documentation for stable release: ```bash mike deploy --push --alias-type=copy 4.2 stable diff --git a/docs/manual/docs/help/record/index.md b/docs/manual/docs/help/record/index.md index 7b7b9c58a7af..df3b8cd7e52e 100644 --- a/docs/manual/docs/help/record/index.md +++ b/docs/manual/docs/help/record/index.md @@ -194,7 +194,7 @@ Download the contents of a single record. - A folder containing complete **`metadata.xml`** record, and simplified ***`metadata-iso19139.xml`*** record. - ***`index.html`** and **`index.csv`** summary described in - the [previous section](#download-from-search-results). + the [previous section](../search/index.md#download-from-search-results). ![](img/export_record_zip.png) *Export (ZIP) index.html summary* diff --git a/docs/manual/docs/overview/change-log/history/index.md b/docs/manual/docs/overview/change-log/history/index.md index c145bbfba887..298f544c4018 100644 --- a/docs/manual/docs/overview/change-log/history/index.md +++ b/docs/manual/docs/overview/change-log/history/index.md @@ -1,6 +1,6 @@ # Release History -The GeoNetwork community is not large enough to maintain many active branches of GeoNetwork at one time. Older installations of GeoNetwork may be subject to disclosed security vulnerabilities resulting in our recommendation to update to the supported [stable](http://docs.geonetwork-opensource.org/stable/) or [maintenance](https://docs.geonetwork-opensource.org/maintenance/) series if available. +The GeoNetwork community is not large enough to maintain many active branches of GeoNetwork at one time. Older installations of GeoNetwork may be subject to disclosed security vulnerabilities resulting in our recommendation to update to the supported [stable](#stable-release) or [maintenance](#maintenance-release) series listed below. Volunteers wishing to backport security fixes to older versions of GeoNetwork are welcome to do so. Commercial support providers are welcome to do so on behalf of their customers. @@ -8,7 +8,7 @@ Volunteers wishing to backport security fixes to older versions of GeoNetwork ar The latest release of GeoNetwork is recommended for those enjoying the newest features from the GeoNetwork community. -This series is under active development by our community, with new features, improvements, documentation updates, bug reports, fixes, and releases. +This series is under **active development** by our community, with new features, improvements, documentation updates, bug reports, fixes, and releases. ### 4.4 @@ -22,7 +22,7 @@ This series is under active development by our community, with new features, imp The stable release of GeoNetwork is recommended for production use and for new installations of GeoNetwork. -This series is under active use by our community, with regular improvements, documentation updates, bug reports, fixes, and releases. +This series is under **active use** by our community, with regular improvements, documentation updates, bug reports, fixes, and releases. ### 4.2 @@ -41,7 +41,7 @@ This series is under active use by our community, with regular improvements, doc The maintenance release of GeoNetwork provides production systems with essential updates and fixes to allow time to upgrade to the recommended stable release. -This series is no longer under active development, providing essential fixes, and releases only. +When available the maintenace series provides **time to upgrade** for our community - limited to providing essential fixes only. ### No maintenance release diff --git a/docs/manual/overrides/partials/main.html b/docs/manual/overrides/main.html similarity index 100% rename from docs/manual/overrides/partials/main.html rename to docs/manual/overrides/main.html