[Backport 4.2.x] flatten changelog into current release and release history for ease of maintenance

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
 
@@ -96,44 +107,26 @@ If you are not familiar with Python the MkDocs-material website has instructions
    mvn install -Pdefault
    ```
 
-## Deploy
+## Publish Documentation
 
-We use ``mike`` for publishing to https://geonetwork.github.io using `<major>.<minor>` version:
+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.
 
-1. To deploy docs from the `main` branch to website `gh-pages` branch:
+If you wish to preview using your own `gh-pages` branch:
 
-   ```bash
-   mike deploy --push --no-redirect --update-aliases 4.4 latest
-   ```
-
-2. To deploy documentation for a new release:
+1. To deploy documentation for a new stable release:
 
    ```bash
-   mike deploy --push --no-redirect --update-aliases 4.2 stable
+   mike deploy --push --alias-type=copy 4.2 stable
    ```
 
-3. When starting a new branch you can make it the default:
-
-   ```bash
-   mike set-default --push 4.2
-   ```
-
-   Hint: When starting a new branch update `overview/changelog/` navigation tree also.
-
-4. To publish documentation for a maintenance release:
-
-   ```bash
-   mike deploy --push --no-redirect --update-aliases 3.12 maintenance
-   ```
-
-5. To show published versions:
+2. To show published versions:
 
    ```bash
 
    mike list
    ```
 
-6. To preview things locally (uses your local ``gh-pages`` branch):
+3. To preview things locally (uses your local ``gh-pages`` branch):
 
    ```bash
    mike serve

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*

docs/manual/docs/maintainer-guide/updating/index.md

@@ -81,5 +81,6 @@ Guidance:
 
 * For information on new features and functionality:
 
-   * [Changelog 4.2.x](../../overview/change-log/stable/index.md)
-   * [Changelog 4.0.x](../../overview/change-log/archive/index.md#40x)
+   * [Changelog 4.2](../../overview/change-log/history/index.md#42)
+   * [Changelog 4.0](../../overview/change-log/history/index.md#40]
+

docs/manual/docs/overview/change-log/archive/index.md → docs/manual/docs/overview/change-log/history/index.md

@@ -1,12 +1,45 @@
-# Archived
+# Release History
 
-The following series of GeoNetwork are no longer in active use and you are encouraged to migrate to a newer version.
-
-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/index.md) or [maintenance](../maintenance/index.md) series.
+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.
 
 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.
 
-## 4.0.x
+## Stable Release
+
+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.
+
+### 4.2
+
+- [Version 4.2.9](../version-4.2.9.md)
+- [Version 4.2.8](../version-4.2.8.md)
+- [Version 4.2.7](../version-4.2.7.md)
+- [Version 4.2.6](../version-4.2.6.md)
+- [Version 4.2.5](../version-4.2.5.md)
+- [Version 4.2.4](../version-4.2.4.md)
+- [Version 4.2.3](../version-4.2.3.md)
+- [Version 4.2.2](../version-4.2.2.md)
+- [Version 4.2.1](../version-4.2.1.md)
+- [Version 4.2.0](../version-4.2.0.md)
+
+## Maintenance Release
+
+The maintenance release of GeoNetwork provides production systems with essential updates and fixes to allow time to upgrade to the recommended stable release. 
+
+When available the maintenace series provides **time to upgrade** for our community - limited to providing essential fixes only.
+
+### No maintenance release
+
+With the final release of 3.12.12 there is no active maintenance release being provided.
+
+Production systems are advised to update to 4.2 above if they have not already done so.
+
+## Archived Releases
+
+The following series of GeoNetwork are no longer in active use and you are encouraged to migrate to a newer version.
+
+### 4.0
 
 -   [Version 4.0.6](../version-4.0.6.md)
 -   [Version 4.0.5](../version-4.0.5.md)
@@ -18,7 +51,7 @@ Volunteers wishing to backport security fixes to older versions of GeoNetwork ar
 -   [Version 4.0.0 Alpha.2](../version-4.0.0-alpha.2.md)
 -   [Version 4.0.0 Alpha.1](../version-4.0.0-alpha.1.md)
 
-## 3.12.x
+### 3.12
 
 -   [Version 3.12.12](../version-3.12.12.md)
 -   [Version 3.12.11](../version-3.12.11.md)
@@ -34,7 +67,7 @@ Volunteers wishing to backport security fixes to older versions of GeoNetwork ar
 -   [Version 3.12.1](../version-3.12.1.md)
 -   [Version 3.12.0](../version-3.12.0.md)
 
-## 3.10.x
+### 3.10
 
 -   [Version 3.10.10](../version-3.10.10.md)
 -   [Version 3.10.9](../version-3.10.9.md)
@@ -66,40 +99,40 @@ Volunteers wishing to backport security fixes to older versions of GeoNetwork ar
 -   [Version 3.0.1](../version-3.0.1.md)
 -   [Version 3.0.0](../version-3.0.0.md)
 
-## 3.8.x
+### 3.8
 
 -   [Version 3.8.3](../version-3.8.3.md)
 -   [Version 3.8.2](../version-3.8.2.md)
 -   [Version 3.8.1](../version-3.8.1.md)
 -   [Version 3.8.0](../version-3.8.0.md)
 
-## 3.6.x
+### 3.6
 
 -   [Version 3.6.0](../version-3.6.0.md)
 
-## 3.4.x
+### 3.4
 
 -   [Version 3.4.4](../version-3.4.4.md)
 -   [Version 3.4.3](../version-3.4.3.md)
 -   [Version 3.4.2](../version-3.4.2.md)
 -   [Version 3.4.1](../version-3.4.1.md)
 -   [Version 3.4.0](../version-3.4.0.md)
 
-## 3.2.x
+### 3.2
 
 -   [Version 3.2.2](../version-3.2.2.md)
 -   [Version 3.2.1](../version-3.2.1.md)
 -   [Version 3.2.0](../version-3.2.0.md)
 
-## 3.0.x
+### 3.0
 
 -   [Version 3.0.4](../version-3.0.4.md)
 -   [Version 3.0.3](../version-3.0.3.md)
 -   [Version 3.0.2](../version-3.0.2.md)
 -   [Version 3.0.1](../version-3.0.1.md)
 -   [Version 3.0.0](../version-3.0.0.md)
 
-## 2.10.x
+### 2.10
 
 All development has ceased:
 

docs/manual/docs/overview/change-log/index.md

@@ -1,7 +1,6 @@
 # Change log
 
-Notable changes made to a GeoNetwork-open source including new features, migration instructions, and bug fixes.
+Notable changes made to GeoNetwork opensource including new features, migration instructions, and bug fixes.
 
--   [Stable](stable/index.md)
--   [Maintenance](maintenance/index.md)
--   [Archive](archive/index.md)
+-   [Version 4.2.9](version-4.2.9.md)
+-   [Release History](history/index.md)

docs/manual/mkdocs.yml

@@ -147,9 +147,9 @@ nav:
     - overview/authors.md
     - 'Changelog':
       - overview/change-log/index.md
-      - 'Stable':
-        - overview/change-log/stable/index.md
-        - overview/change-log/version-4.2.9.md
+      - overview/change-log/version-4.2.9.md
+      - 'Release History':
+        - overview/change-log/history/index.md
         - overview/change-log/version-4.2.8.md
         - overview/change-log/version-4.2.7.md
         - overview/change-log/version-4.2.6.md
@@ -159,8 +159,6 @@ nav:
         - overview/change-log/version-4.2.2.md
         - overview/change-log/version-4.2.1.md
         - overview/change-log/version-4.2.0.md
-      - 'Archive':
-        - overview/change-log/archive/index.md
         - overview/change-log/version-3.12.12.md
         - overview/change-log/version-3.12.11.md
         - overview/change-log/version-3.12.10.md
@@ -174,7 +172,6 @@ nav:
         - overview/change-log/version-3.12.2.md
         - overview/change-log/version-3.12.1.md
         - overview/change-log/version-3.12.0.md
-        - overview/change-log/archive/index.md
         - overview/change-log/version-4.0.6.md
         - overview/change-log/version-4.0.5.md
         - overview/change-log/version-4.0.4.md

docs/manual/overrides/main.html

@@ -0,0 +1,6 @@
+{% extends "base.html" %}
+
+{% block outdated %}
+  GeoNetwork 4.2 is outdated.
+  <a href="{{ '../' ~ base_url }}"><strong>Click here to go to stable.</strong></a>
+{% endblock %}