chore: move upgrades and deprecations to docs

DEPRECATIONS.md

@@ -8,26 +8,4 @@ Deprecations will be tracked by the release they are announced in, and then upda
 
 ## Deprecation History
 
-All deprecations are listed below, with the most recent announcements at the top.
-
-### Lagoon v2.18.0
-release link: https://github.com/uselagoon/lagoon/releases/tag/v2.18.0
-* The standard drupal based tasks that Lagoon ships with (drush ....) have been flagged as deprecated and should not be used anymore. These will need to be replaced with [custom tasks](https://docs.lagoon.sh/using-lagoon-advanced/custom-tasks/). Example replacement tasks will be provided prior to their removal.
-* This release introduces a deprecation of the `setEnvironmentServices` mutation to updated services for an environment, it is being replaced with `addOrUpdateEnvironmentService` and `deleteEnvironmentService`. This is becaues the type is being refactored to support additional information, and eventually additional functionality. For now, the actions-handler service will still support the older `setEnvironmentServices` for backwards compatability for a short period to allow older versions of `lagoon-remote` to still work, but a new version of `lagoon-remote` will be available that will no longer provides the payload that the actions-handler uses.
-* The value for `registry` which was previously required by the `lagoon-core` chart is no longer required. If you are using this, you will need to add it under the new `unauthenticatedRegistry` setting when installing `lagoon-remote` in the `lagoon-build-deploy` section of your values file. If you aren't using an actual registry and have the example `disabled-only-use-harbor-via-deploy-controller.invalid` value, then you do not need to do anything except you can now remove the `registry` setting from your core values file.
-* The environment storage return field named `bytesUsed` is deprecated. The actual value stored is `kibibytes`. A new return field called `kibUsed` exists and should be used, the returned data is the same and both fields are still returned. `bytesUsed` will be removed in a future release, make any adjustments now to use `kibUsed`. This will be a breaking change in a future release.
-* `addOrUpdateEnvironmentStorage` is deprecated, `addOrUpdateStorageOnEnvironment` is the replacement to use as it supports the updated input value for `kibUsed`. `addOrUpdateEnvironmentStorage` will be completely removed in a future release.
-* The ability to configure projects to use different subsystems for managing deployments/tasks has been removed. Setting any values for the `activeSystems*` fields on the project will have no effect and the fields will be removed in a future release.
-
-### Lagoon v2.17.0
-
-release link: https://github.com/uselagoon/lagoon/releases/tag/v2.17.0
-* This release introduces a new active/standby task image that does not require the use of the [dioscuri controller](https://github.com/amazeeio/dioscuri). Dioscuri is deprecated and will eventually be removed from the `lagoon-remote` helm chart. If you use active/standby functionality in your clusters, you should upgrade to lagoon v2.17.0 and update your remote clusters to the version of the `lagoon-remote` helm chart the v2.17.0 release says to use (see release notes for v2.17.0)
-* Support for Harbor in the API will be removed in a future release. If you currently have your core installation with Harbor support, you should move to using the integration within lagoon-remote instead. See the documentation [here](https://docs.lagoon.sh/installing-lagoon/install-lagoon-remote) and read the section about Harbor.
-* Support for Harbor 2.1.x (chart version 1.5.x) and older in `lagoon-remote` will be removed in a future release. You should consider upgrading Harbor to a newer version (currently Lagoon supports up to v2.9.x (chart version 1.13.x)), following any recommended upgrade paths from Harbor.
-
-### Lagoon v2.16.0
-
-release link: https://github.com/uselagoon/lagoon/releases/tag/v2.16.0
-
-There were no planned deprecations announced in this release.
+See https://docs.lagoon.sh/deprecations/summary/

UPGRADES.md

@@ -0,0 +1,8 @@
+# Lagoon Project Upgrades
+
+Whenever there is important information around versions of Lagoon that may impact the ability to upgrade to a new version, there will be upgrade information notes provided.
+
+You should always read all version release notes, upgrade notes, and deprecation notices for all versions you upgrade to.
+
+## Upgrade Information
+See https://docs.lagoon.sh/upgrades/policy/

docs/deprecations/.pages

@@ -0,0 +1,5 @@
+title: Deprecations
+order: desc
+nav:
+  - Summary: summary.md
+  - ...

docs/deprecations/2.17.0.md

@@ -0,0 +1,8 @@
+
+### Lagoon v2.17.0
+
+Release link: [https://github.com/uselagoon/lagoon/releases/tag/v2.17.0](https://github.com/uselagoon/lagoon/releases/tag/v2.17.0)
+
+* This release introduces a new active/standby task image that does not require the use of the [dioscuri controller](https://github.com/amazeeio/dioscuri). Dioscuri is deprecated and will eventually be removed from the `lagoon-remote` helm chart. If you use active/standby functionality in your clusters, you should upgrade to lagoon v2.17.0 and update your remote clusters to the version of the `lagoon-remote` helm chart the v2.17.0 release says to use (see release notes for v2.17.0)
+* Support for Harbor in the API will be removed in a future release. If you currently have your core installation with Harbor support, you should move to using the integration within lagoon-remote instead. See the documentation [here](https://docs.lagoon.sh/installing-lagoon/install-lagoon-remote) and read the section about Harbor.
+* Support for Harbor 2.1.x (chart version 1.5.x) and older in `lagoon-remote` will be removed in a future release. You should consider upgrading Harbor to a newer version (currently Lagoon supports up to v2.9.x (chart version 1.13.x)), following any recommended upgrade paths from Harbor.

docs/deprecations/2.18.0.md

@@ -0,0 +1,11 @@
+
+### Lagoon v2.18.0
+
+release link: [https://github.com/uselagoon/lagoon/releases/tag/v2.18.0](https://github.com/uselagoon/lagoon/releases/tag/v2.18.0)
+
+* The standard drupal based tasks that Lagoon ships with (drush ....) have been flagged as deprecated and should not be used anymore. These will need to be replaced with [custom tasks](https://docs.lagoon.sh/using-lagoon-advanced/custom-tasks/). Example replacement tasks will be provided prior to their removal.
+* This release introduces a deprecation of the `setEnvironmentServices` mutation to updated services for an environment, it is being replaced with `addOrUpdateEnvironmentService` and `deleteEnvironmentService`. This is becaues the type is being refactored to support additional information, and eventually additional functionality. For now, the actions-handler service will still support the older `setEnvironmentServices` for backwards compatability for a short period to allow older versions of `lagoon-remote` to still work, but a new version of `lagoon-remote` will be available that will no longer provides the payload that the actions-handler uses.
+* The value for `registry` which was previously required by the `lagoon-core` chart is no longer required. If you are using this, you will need to add it under the new `unauthenticatedRegistry` setting when installing `lagoon-remote` in the `lagoon-build-deploy` section of your values file. If you aren't using an actual registry and have the example `disabled-only-use-harbor-via-deploy-controller.invalid` value, then you do not need to do anything except you can now remove the `registry` setting from your core values file.
+* The environment storage return field named `bytesUsed` is deprecated. The actual value stored is `kibibytes`. A new return field called `kibUsed` exists and should be used, the returned data is the same and both fields are still returned. `bytesUsed` will be removed in a future release, make any adjustments now to use `kibUsed`. This will be a breaking change in a future release.
+* `addOrUpdateEnvironmentStorage` is deprecated, `addOrUpdateStorageOnEnvironment` is the replacement to use as it supports the updated input value for `kibUsed`. `addOrUpdateEnvironmentStorage` will be completely removed in a future release.
+* The ability to configure projects to use different subsystems for managing deployments/tasks has been removed. Setting any values for the `activeSystems*` fields on the project will have no effect and the fields will be removed in a future release.

docs/deprecations/summary.md

@@ -0,0 +1,9 @@
+# Deprecations
+
+This is a constantly updated central tracker for deprecations across the suite of Lagoon products.
+
+As Lagoon continues to evolve, we occasionally need to replace, rename or retire existing processes, tools or configuration. Where this may impact a user's processes or procedures, we intend to outline a timeframe to allow any necessary changes to be made.
+
+Deprecations will be tracked by the release they are announced in, and then updated when the actual deprecation occurs.
+
+All deprecations should provide a rough timeline (in months or releases). Releases will normally only be listed here if they include planned deprecations.

docs/requirements.txt

@@ -2,3 +2,4 @@ mkdocs-material
 mkdocs-redirects
 mdx_truly_sane_lists
 mkdocs-git-revision-date-localized-plugin
+mkdocs-awesome-pages-plugin

docs/upgrades/.pages

@@ -0,0 +1,5 @@
+title: Upgrades
+order: desc
+nav:
+  - Policy: policy.md
+  - ...

docs/upgrades/2.10.0.md

@@ -0,0 +1,4 @@
+### Upgrade to Lagoon v2.10.0
+You must upgrade to Lagoon v2.9.x before upgrading to v2.10.0.
+
+Ensure you read the [release notes](https://github.com/uselagoon/lagoon/releases/tag/v2.10.0) before upgrading to make sure you are aware of all the changes you may be required to do.

docs/upgrades/2.11.0.md

@@ -0,0 +1,5 @@
+### Upgrade to Lagoon v2.11.0
+
+You must upgrade to Lagoon v2.10.0 before upgrading to v2.11.0.
+
+Ensure you read the [release notes](https://github.com/uselagoon/lagoon/releases/tag/v2.11.0) before upgrading to make sure you are aware of all the changes you may be required to do.

docs/upgrades/policy.md

@@ -0,0 +1,12 @@
+# Upgrade Policy
+
+Our general policy is that you should upgrade to each minor version before you upgrade to the latest version.
+
+You should check all upgrade requirements and deprecation notices for all versions as you upgrade.
+
+An example of our suggested policy is as follows
+
+* Currently installed v2.14.0, planning to upgrade to v2.17.0
+  1. Upgrade to v2.15.0
+  2. Upgrade to v2.16.0
+  3. Upgrade to v2.17.0

mkdocs.yml

@@ -161,6 +161,8 @@ nav:
   - Lagoon CLI: https://uselagoon.github.io/lagoon-cli/
   - Lagoon Sync: https://github.com/uselagoon/lagoon-sync
   - Client Libraries: other-tools/client-libraries.md
+- ... | upgrades/*
+- ... | deprecations/*
 
 theme:
   name: 'material'
@@ -238,6 +240,7 @@ markdown_extensions:
 
 plugins:
   - search
+  - awesome-pages
   - redirects:
       redirect_maps:
         # Shortcut URLs for build and compose errors