From 7caa17e47751870e5912a2788ec6835046f8e4e7 Mon Sep 17 00:00:00 2001 From: Jody Garnett Date: Thu, 23 May 2024 08:19:24 -0700 Subject: [PATCH] flatten changelog into current release and release history for ease of maintenance (#7887) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * 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 Rodríguez --- docs/manual/README.md | 22 ++++--- .../docs/maintainer-guide/updating/index.md | 7 ++- .../change-log/{archive => history}/index.md | 62 ++++++++++++++----- docs/manual/docs/overview/change-log/index.md | 7 +-- .../docs/overview/change-log/latest/index.md | 16 ----- .../overview/change-log/maintenance/index.md | 5 -- .../docs/overview/change-log/stable/index.md | 21 ------- docs/manual/mkdocs.yml | 31 +++++----- docs/manual/overrides/partials/main.html | 6 ++ 9 files changed, 87 insertions(+), 90 deletions(-) rename docs/manual/docs/overview/change-log/{archive => history}/index.md (72%) delete mode 100644 docs/manual/docs/overview/change-log/latest/index.md delete mode 100644 docs/manual/docs/overview/change-log/maintenance/index.md delete mode 100644 docs/manual/docs/overview/change-log/stable/index.md create mode 100644 docs/manual/overrides/partials/main.html diff --git a/docs/manual/README.md b/docs/manual/README.md index 6a32791b9e9..1aba8def34d 100644 --- 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 `.` 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 index 48cb0ac2b92..a7c56978ee6 100644 --- 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/manual/docs/overview/change-log/archive/index.md b/docs/manual/docs/overview/change-log/history/index.md similarity index 72% rename from docs/manual/docs/overview/change-log/archive/index.md rename to docs/manual/docs/overview/change-log/history/index.md index e9a5632fb8c..c145bbfba88 100644 --- a/docs/manual/docs/overview/change-log/archive/index.md +++ b/docs/manual/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,18 +113,18 @@ 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) @@ -98,13 +132,13 @@ Volunteers wishing to backport security fixes to older versions of GeoNetwork ar - [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) @@ -112,7 +146,7 @@ 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) -## 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 index 83a627c6074..8b8a2296939 100644 --- 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 deleted file mode 100644 index 45852cafb0e..00000000000 --- a/docs/manual/docs/overview/change-log/latest/index.md +++ /dev/null @@ -1,16 +0,0 @@ -# Latest - -GeoNetwork 4.4.x 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. - -## Latest - -- [Version 4.4.4](../version-4.4.4.md) - -## History - -- [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) diff --git a/docs/manual/docs/overview/change-log/maintenance/index.md b/docs/manual/docs/overview/change-log/maintenance/index.md deleted file mode 100644 index 596b610eacc..00000000000 --- a/docs/manual/docs/overview/change-log/maintenance/index.md +++ /dev/null @@ -1,5 +0,0 @@ -# Maintenance - -The GeoNetwork 3.12.x series has reach end-of-life and been archived. - -There is no active maintenance release available. diff --git a/docs/manual/docs/overview/change-log/stable/index.md b/docs/manual/docs/overview/change-log/stable/index.md deleted file mode 100644 index ad5d4b53c6f..00000000000 --- a/docs/manual/docs/overview/change-log/stable/index.md +++ /dev/null @@ -1,21 +0,0 @@ -# Stable - -The GeoNetwork 4.2.x series is stable and recommended for production use and new installations of GeoNetwork. -This series is under active use by our community, with regular improvements, documentation updates, bug reports, fixes, and releases. - -## Latest - -- [Version 4.2.9](../version-4.2.9.md) - - -## History - -- [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) diff --git a/docs/manual/mkdocs.yml b/docs/manual/mkdocs.yml index cb1a3120db8..d71da399389 100644 --- 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 new file mode 100644 index 00000000000..ec27b00bfb2 --- /dev/null +++ b/docs/manual/overrides/partials/main.html @@ -0,0 +1,6 @@ +{% extends "base.html" %} + +{% block outdated %} + GeoNetwork 4.4 is outdated. + Click here to go to stable. +{% endblock %}