flatten changelog into current release and release history for ease o…

…f maintenance (#7887) * flatten changelog into current release and release history for ease of maintenance * Deploy instructons with banner when viewing non stable docs * fixup! Deploy instructons with banner when viewing non stable docs * fixup! fixup! Deploy instructons with banner when viewing non stable docs --------- Co-authored-by: Juan Luis Rodríguez <[email protected]>
geonetwork · May 23, 2024 · 7caa17e · 7caa17e
1 parent 88d7b13
commit 7caa17e
Show file tree

Hide file tree

Showing 9 changed files with 87 additions and 90 deletions.
diff --git a/docs/manual/README.md b/docs/manual/README.md
@@ -96,34 +96,36 @@ 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:
+
+1. To deploy 4.4 docs as latest from the `main` branch to website `gh-pages` branch:
 
    ```bash
-   mike deploy --push --no-redirect --update-aliases 4.4 latest
+   mike deploy --title "4.4 Latest" --alias-type=copy --update-aliases 4.4 latest
    ```
-    
+
 2. To deploy documentation for a new 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
+   mike set-default --push 4.6
    ```
-
-   Hint: When starting a new branch update `overview/changelog/` navigation tree also.
+    
+   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:
 
    ```bash
-   mike deploy --push --no-redirect --update-aliases 3.12 maintenance
+   mike deploy --push --alias-type=copy 3.12 maintenance
    ```
 
 5. To show published versions:

diff --git a/docs/manual/docs/maintainer-guide/updating/index.md b/docs/manual/docs/maintainer-guide/updating/index.md
@@ -99,7 +99,7 @@ Update:
         
 Guidance:
 
-* [Changelog 4.4.x](../../overview/change-log/latest/index.md)
+* [Changelog 4.4](../../overview/change-log/history/index.md#44)
 * No additional guidance provided at this time.
 
 ## Upgrade from GeoNetwork 3.0 to GeoNetwork 4.4
@@ -161,5 +161,6 @@ Guidance:
 
 * For information on new features and functionality:
 
-   * [Changelog 4.4.x](../../overview/change-log/latest/index.md)
-   * [Changelog 4.0.x](../../overview/change-log/archive/index.md#40x)
+   * [Changelog 4.4](../../overview/change-log/history/index.md#44)
+   * [Changelog 4.2](../../overview/change-log/history/index.md#42)
+   * [Changelog 4.0](../../overview/change-log/history/index.md#40)
diff --git a/...docs/overview/change-log/archive/index.md → ...docs/overview/change-log/history/index.md b/...docs/overview/change-log/archive/index.md → ...docs/overview/change-log/history/index.md
@@ -1,12 +1,30 @@
-# 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 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](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.2.x
+## Latest Release
+
+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.
+
+### 4.4
+
+-   [Version 4.4.4](../version-4.4.4.md)
+-   [Version 4.4.3](../version-4.4.3.md)
+-   [Version 4.4.2](../version-4.4.2.md)
+-   [Version 4.4.1](../version-4.4.1.md)
+-   [Version 4.4.0](../version-4.4.0.md)
+
+## 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)
@@ -19,7 +37,23 @@ Volunteers wishing to backport security fixes to older versions of GeoNetwork ar
 - [Version 4.2.1](../version-4.2.1.md)
 - [Version 4.2.0](../version-4.2.0.md)
 
-## 4.0.x
+## 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. 
+
+This series is no longer under active development, providing essential fixes, and releases 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)
@@ -31,7 +65,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)
@@ -47,7 +81,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)
@@ -79,40 +113,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:
 

diff --git a/docs/manual/docs/overview/change-log/index.md b/docs/manual/docs/overview/change-log/index.md
@@ -2,7 +2,6 @@
 
 Notable changes made to GeoNetwork opensource including new features, migration instructions, and bug fixes.
 
--   [Latest](latest/index.md)
--   [Stable](stable/index.md)
--   [Maintenance](maintenance/index.md)
--   [Archive](archive/index.md)
+-   [Version 4.4.4](version-4.4.4.md)
+-   [Version 4.2.9](version-4.2.9.md)
+-   [Release History](history/index.md)
diff --git a/docs/manual/docs/overview/change-log/latest/index.md b/docs/manual/docs/overview/change-log/latest/index.md
diff --git a/docs/manual/docs/overview/change-log/maintenance/index.md b/docs/manual/docs/overview/change-log/maintenance/index.md
diff --git a/docs/manual/docs/overview/change-log/stable/index.md b/docs/manual/docs/overview/change-log/stable/index.md
diff --git a/docs/manual/mkdocs.yml b/docs/manual/mkdocs.yml
@@ -39,17 +39,18 @@ theme:
         icon: material/weather-sunny
         name: Switch to light mode
   features:
-    - content.action.view
-    - content.action.edit
-    - content.code.copy
-    - content.tabs.link
-    - navigation.tabs
+    - toc.follow
     - navigation.tracking
+    - navigation.top
+    - navigation.tabs
     - navigation.prune
     - navigation.indexes
-    - toc.follow
-    - navigation.top
     - navigation.footer
+    - header.autohide
+    - content.tabs.link
+    - content.code.copy
+    - content.action.view
+    - content.action.edit
     - announce.dismiss
 
 # Plugins - install using: pip3 install -r requirements.txt
@@ -65,11 +66,11 @@ plugins:
           name: English
           build: true
           default: true
-          site_name: 'GeoNetwork opensource (EN)'
+          site_name: 'GeoNetwork opensource'
         - locale: fr
           name: Français
           build: !ENV [FRENCH,true]
-          site_name: 'GeoNetwork opensource (FR)'
+          site_name: 'GeoNetwork opensource'
           site_description: Catalogue GeoNetwork pour répertorier, rechercher et examiner les enregistrements.
           nav_translations:
             Home: Home
@@ -147,15 +148,15 @@ nav:
     - overview/authors.md
     - 'Changelog':
       - overview/change-log/index.md
-      - 'Latest':
-        - overview/change-log/latest/index.md
+      - overview/change-log/version-4.4.4.md
+      - overview/change-log/version-4.2.9.md
+      - 'Release History':
+        - overview/change-log/history/index.md
         - overview/change-log/version-4.4.4.md
         - overview/change-log/version-4.4.3.md
         - overview/change-log/version-4.4.2.md
         - overview/change-log/version-4.4.1.md
         - overview/change-log/version-4.4.0.md
-      - 'Stable':
-        - overview/change-log/stable/index.md
         - overview/change-log/version-4.2.9.md
         - overview/change-log/version-4.2.8.md
         - overview/change-log/version-4.2.7.md
@@ -166,8 +167,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
-      - 'Maintenance':
-        - overview/change-log/maintenance/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
@@ -181,8 +180,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
-      - 'Archive':
-        - 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

diff --git a/docs/manual/overrides/partials/main.html b/docs/manual/overrides/partials/main.html
@@ -0,0 +1,6 @@
+{% extends "base.html" %}
+
+{% block outdated %}
+  GeoNetwork 4.4 is outdated.
+  <a href="{{ '../' ~ base_url }}"><strong>Click here to go to stable.</strong></a>
+{% endblock %}