add upgrade advisory to all docs

Signed-off-by: Daniel Holbach <[email protected]>
fluxcd · Nov 1, 2022 · ec89399 · ec89399
1 parent eaa8d99
commit ec89399
Show file tree

Hide file tree

Showing 23 changed files with 185 additions and 0 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -1,5 +1,13 @@
 # Helm Operator
 
+> **🛑 Upgrade Advisory**
+>
+> This documentation is for Helm Operator (v1) which has [reached its end-of-life in November 2022](https://fluxcd.io/blog/2022/10/september-2022-update/#flux-legacy-v1-retirement-plan).
+>
+> We strongly recommend you familiarise yourself with the newest Flux and [migrate as soon as possible](https://fluxcd.io/flux/migration/).
+>
+> For documentation regarding the latest Flux, please refer to [this section](https://fluxcd.io/flux/).
+
 The Helm Operator is a [Kubernetes operator](https://kubernetes.io/docs/concepts/extend-kubernetes/operator/),
 allowing one to declaratively manage Helm chart releases. Combined with
 [Flux](https://github.com/fluxcd/flux) this can be utilized to automate

diff --git a/docs/contributing/building.md b/docs/contributing/building.md
@@ -1,5 +1,13 @@
 # Building
 
+> **🛑 Upgrade Advisory**
+>
+> This documentation is for Helm Operator (v1) which has [reached its end-of-life in November 2022](https://fluxcd.io/blog/2022/10/september-2022-update/#flux-legacy-v1-retirement-plan).
+>
+> We strongly recommend you familiarise yourself with the newest Flux and [migrate as soon as possible](https://fluxcd.io/flux/migration/).
+>
+> For documentation regarding the latest Flux, please refer to [this section](https://fluxcd.io/flux/).
+
 You'll need a working `go` environment version >= 1.11 (official releases are built against `1.14.x`).
 It's also expected that you have a Docker daemon for building images.
 

diff --git a/docs/contributing/get-started-developing.md b/docs/contributing/get-started-developing.md
@@ -1,5 +1,13 @@
 # Get started developing
 
+> **🛑 Upgrade Advisory**
+>
+> This documentation is for Helm Operator (v1) which has [reached its end-of-life in November 2022](https://fluxcd.io/blog/2022/10/september-2022-update/#flux-legacy-v1-retirement-plan).
+>
+> We strongly recommend you familiarise yourself with the newest Flux and [migrate as soon as possible](https://fluxcd.io/flux/migration/).
+>
+> For documentation regarding the latest Flux, please refer to [this section](https://fluxcd.io/flux/).
+
 This guide shows you how to make a small change to the Helm Operator and then build and test that change locally using a Kind cluster.
 
 ## Prepare your environment

diff --git a/docs/faq.md b/docs/faq.md
@@ -1,5 +1,13 @@
 # Frequently asked questions
 
+> **🛑 Upgrade Advisory**
+>
+> This documentation is for Helm Operator (v1) which has [reached its end-of-life in November 2022](https://fluxcd.io/blog/2022/10/september-2022-update/#flux-legacy-v1-retirement-plan).
+>
+> We strongly recommend you familiarise yourself with the newest Flux and [migrate as soon as possible](https://fluxcd.io/flux/migration/).
+>
+> For documentation regarding the latest Flux, please refer to [this section](https://fluxcd.io/flux/).
+
 ### A `HelmRelease` is stuck in a `failed` release state. How do I force it through?
 
 You need to manually perform a `helm rollback` or `helm upgrade` to get it in

diff --git a/docs/get-started/quickstart.md b/docs/get-started/quickstart.md
@@ -1,5 +1,13 @@
 # Quickstart
 
+> **🛑 Upgrade Advisory**
+>
+> This documentation is for Helm Operator (v1) which has [reached its end-of-life in November 2022](https://fluxcd.io/blog/2022/10/september-2022-update/#flux-legacy-v1-retirement-plan).
+>
+> We strongly recommend you familiarise yourself with the newest Flux and [migrate as soon as possible](https://fluxcd.io/flux/migration/).
+>
+> For documentation regarding the latest Flux, please refer to [this section](https://fluxcd.io/flux/).
+
 This guide walks you through to all steps required to quickly get
 started with the Helm Operator.
 

diff --git a/docs/get-started/using-helm.md b/docs/get-started/using-helm.md
@@ -1,5 +1,13 @@
 # Get started using Helm
 
+> **🛑 Upgrade Advisory**
+>
+> This documentation is for Helm Operator (v1) which has [reached its end-of-life in November 2022](https://fluxcd.io/blog/2022/10/september-2022-update/#flux-legacy-v1-retirement-plan).
+>
+> We strongly recommend you familiarise yourself with the newest Flux and [migrate as soon as possible](https://fluxcd.io/flux/migration/).
+>
+> For documentation regarding the latest Flux, please refer to [this section](https://fluxcd.io/flux/).
+
 This guide walks you through setting up the Helm Operator using the
 available [Helm chart](https://github.com/fluxcd/helm-operator/tree/master/chart/helm-operator).
 

diff --git a/docs/get-started/using-kustomize.md b/docs/get-started/using-kustomize.md
@@ -1,5 +1,13 @@
 # Get started using Kustomize
 
+> **🛑 Upgrade Advisory**
+>
+> This documentation is for Helm Operator (v1) which has [reached its end-of-life in November 2022](https://fluxcd.io/blog/2022/10/september-2022-update/#flux-legacy-v1-retirement-plan).
+>
+> We strongly recommend you familiarise yourself with the newest Flux and [migrate as soon as possible](https://fluxcd.io/flux/migration/).
+>
+> For documentation regarding the latest Flux, please refer to [this section](https://fluxcd.io/flux/).
+
 This guide walks you through setting up the Helm Operator using
 [Kustomize](https://kustomize.io).
 

diff --git a/docs/get-started/using-yamls.md b/docs/get-started/using-yamls.md
@@ -1,5 +1,13 @@
 # Get started using YAMLs
 
+> **🛑 Upgrade Advisory**
+>
+> This documentation is for Helm Operator (v1) which has [reached its end-of-life in November 2022](https://fluxcd.io/blog/2022/10/september-2022-update/#flux-legacy-v1-retirement-plan).
+>
+> We strongly recommend you familiarise yourself with the newest Flux and [migrate as soon as possible](https://fluxcd.io/flux/migration/).
+>
+> For documentation regarding the latest Flux, please refer to [this section](https://fluxcd.io/flux/).
+
 This guide walks you through setting up the Helm Operator using
 [deployment YAMLs](https://github.com/fluxcd/helm-operator/tree/1.4.4/deploy).
 

diff --git a/docs/helmrelease-guide/automation.md b/docs/helmrelease-guide/automation.md
@@ -1,5 +1,13 @@
 # Automation
 
+> **🛑 Upgrade Advisory**
+>
+> This documentation is for Helm Operator (v1) which has [reached its end-of-life in November 2022](https://fluxcd.io/blog/2022/10/september-2022-update/#flux-legacy-v1-retirement-plan).
+>
+> We strongly recommend you familiarise yourself with the newest Flux and [migrate as soon as possible](https://fluxcd.io/flux/migration/).
+>
+> For documentation regarding the latest Flux, please refer to [this section](https://fluxcd.io/flux/).
+
 This section of the guide is mostly a clarification of some common
 misconceptions about (non-existent) automation features of the Helm Operator.
 

diff --git a/docs/helmrelease-guide/chart-sources.md b/docs/helmrelease-guide/chart-sources.md
@@ -1,5 +1,13 @@
 # Chart sources
 
+> **🛑 Upgrade Advisory**
+>
+> This documentation is for Helm Operator (v1) which has [reached its end-of-life in November 2022](https://fluxcd.io/blog/2022/10/september-2022-update/#flux-legacy-v1-retirement-plan).
+>
+> We strongly recommend you familiarise yourself with the newest Flux and [migrate as soon as possible](https://fluxcd.io/flux/migration/).
+>
+> For documentation regarding the latest Flux, please refer to [this section](https://fluxcd.io/flux/).
+
 In the introduction we created a simple `HelmRelease` that made use of a chart
 from a Helm repository, but the Helm Operator does support multiple chart
 sources, and virtually any protocol and/or source that can be shelled-in

diff --git a/docs/helmrelease-guide/debugging.md b/docs/helmrelease-guide/debugging.md
@@ -1,5 +1,13 @@
 # Debugging
 
+> **🛑 Upgrade Advisory**
+>
+> This documentation is for Helm Operator (v1) which has [reached its end-of-life in November 2022](https://fluxcd.io/blog/2022/10/september-2022-update/#flux-legacy-v1-retirement-plan).
+>
+> We strongly recommend you familiarise yourself with the newest Flux and [migrate as soon as possible](https://fluxcd.io/flux/migration/).
+>
+> For documentation regarding the latest Flux, please refer to [this section](https://fluxcd.io/flux/).
+
 Even after having read everything this guide has to offer it is possible that a
 `HelmRelease` fails and you want to debug it to get to the cause. This may be
 a bit harder at first than you were used to while working with just `helm`

diff --git a/docs/helmrelease-guide/introduction.md b/docs/helmrelease-guide/introduction.md
@@ -1,5 +1,13 @@
 # Introduction
 
+> **🛑 Upgrade Advisory**
+>
+> This documentation is for Helm Operator (v1) which has [reached its end-of-life in November 2022](https://fluxcd.io/blog/2022/10/september-2022-update/#flux-legacy-v1-retirement-plan).
+>
+> We strongly recommend you familiarise yourself with the newest Flux and [migrate as soon as possible](https://fluxcd.io/flux/migration/).
+>
+> For documentation regarding the latest Flux, please refer to [this section](https://fluxcd.io/flux/).
+
 The intention of this guide is to give you more detailed information on various
 elements of the `HelmRelease` Custom Resource. You can follow it in one take,
 use it as a more explanatory reference, or a combination of both.

diff --git a/docs/helmrelease-guide/reconciliation-and-upgrades.md b/docs/helmrelease-guide/reconciliation-and-upgrades.md
@@ -1,5 +1,13 @@
 # Reconciliation and upgrades
 
+> **🛑 Upgrade Advisory**
+>
+> This documentation is for Helm Operator (v1) which has [reached its end-of-life in November 2022](https://fluxcd.io/blog/2022/10/september-2022-update/#flux-legacy-v1-retirement-plan).
+>
+> We strongly recommend you familiarise yourself with the newest Flux and [migrate as soon as possible](https://fluxcd.io/flux/migration/).
+>
+> For documentation regarding the latest Flux, please refer to [this section](https://fluxcd.io/flux/).
+
 Now that you know the ins and outs of configuring a release, we are going to
 have a better look at how the Helm Operator performs the actual Helm release.
 

diff --git a/docs/helmrelease-guide/release-configuration.md b/docs/helmrelease-guide/release-configuration.md
@@ -1,5 +1,13 @@
 # Release configuration
 
+> **🛑 Upgrade Advisory**
+>
+> This documentation is for Helm Operator (v1) which has [reached its end-of-life in November 2022](https://fluxcd.io/blog/2022/10/september-2022-update/#flux-legacy-v1-retirement-plan).
+>
+> We strongly recommend you familiarise yourself with the newest Flux and [migrate as soon as possible](https://fluxcd.io/flux/migration/).
+>
+> For documentation regarding the latest Flux, please refer to [this section](https://fluxcd.io/flux/).
+
 When making use of the `helm` binary you can pass along various flags while
 making a release that influence how a release is performed. Most of these flags
 are also available as parameters in the `spec` of the `HelmRelease` resource,

diff --git a/docs/helmrelease-guide/rollbacks.md b/docs/helmrelease-guide/rollbacks.md
@@ -1,5 +1,13 @@
 # Rollbacks
 
+> **🛑 Upgrade Advisory**
+>
+> This documentation is for Helm Operator (v1) which has [reached its end-of-life in November 2022](https://fluxcd.io/blog/2022/10/september-2022-update/#flux-legacy-v1-retirement-plan).
+>
+> We strongly recommend you familiarise yourself with the newest Flux and [migrate as soon as possible](https://fluxcd.io/flux/migration/).
+>
+> For documentation regarding the latest Flux, please refer to [this section](https://fluxcd.io/flux/).
+
 From time to time a release made by the Helm Operator may fail, this section
 of the guide will explain how you can recover from a failed release by enabling
 rollbacks.

diff --git a/docs/helmrelease-guide/tests.md b/docs/helmrelease-guide/tests.md
@@ -1,5 +1,13 @@
 # Tests
 
+> **🛑 Upgrade Advisory**
+>
+> This documentation is for Helm Operator (v1) which has [reached its end-of-life in November 2022](https://fluxcd.io/blog/2022/10/september-2022-update/#flux-legacy-v1-retirement-plan).
+>
+> We strongly recommend you familiarise yourself with the newest Flux and [migrate as soon as possible](https://fluxcd.io/flux/migration/).
+>
+> For documentation regarding the latest Flux, please refer to [this section](https://fluxcd.io/flux/).
+
 [Helm tests](https://helm.sh/docs/topics/chart_tests/) are a useful validation
 mechanism for Helm Releases, and thus are supported by the Helm Operator.
 

diff --git a/docs/helmrelease-guide/values.md b/docs/helmrelease-guide/values.md
@@ -1,5 +1,13 @@
 # Values
 
+> **🛑 Upgrade Advisory**
+>
+> This documentation is for Helm Operator (v1) which has [reached its end-of-life in November 2022](https://fluxcd.io/blog/2022/10/september-2022-update/#flux-legacy-v1-retirement-plan).
+>
+> We strongly recommend you familiarise yourself with the newest Flux and [migrate as soon as possible](https://fluxcd.io/flux/migration/).
+>
+> For documentation regarding the latest Flux, please refer to [this section](https://fluxcd.io/flux/).
+
 Now that we have a good understanding of where we can get our charts from and
 what they have to offer, it is time to examine how you can supply
 [values](https://helm.sh/docs/glossary/#values-values-files-values-yaml) to

diff --git a/docs/how-to/upgrade-to-beta.md b/docs/how-to/upgrade-to-beta.md
@@ -1,5 +1,13 @@
 # Upgrade from alpha (<=0.4.0) to beta
 
+> **🛑 Upgrade Advisory**
+>
+> This documentation is for Helm Operator (v1) which has [reached its end-of-life in November 2022](https://fluxcd.io/blog/2022/10/september-2022-update/#flux-legacy-v1-retirement-plan).
+>
+> We strongly recommend you familiarise yourself with the newest Flux and [migrate as soon as possible](https://fluxcd.io/flux/migration/).
+>
+> For documentation regarding the latest Flux, please refer to [this section](https://fluxcd.io/flux/).
+
 The Helm Operator has undergone changes that necessitate some changes
 to custom resources, and the deployment of the operator itself.
 

diff --git a/docs/how-to/upgrade-to-ga.md b/docs/how-to/upgrade-to-ga.md
@@ -1,5 +1,13 @@
 # Upgrade from beta (>=0.5.0) to stable (>=1.0.0)
 
+> **🛑 Upgrade Advisory**
+>
+> This documentation is for Helm Operator (v1) which has [reached its end-of-life in November 2022](https://fluxcd.io/blog/2022/10/september-2022-update/#flux-legacy-v1-retirement-plan).
+>
+> We strongly recommend you familiarise yourself with the newest Flux and [migrate as soon as possible](https://fluxcd.io/flux/migration/).
+>
+> For documentation regarding the latest Flux, please refer to [this section](https://fluxcd.io/flux/).
+
 Due to the Flux project joining the CNCF Sandbox and the API
 becoming stable, the Helm Operator has undergone changes that
 necessitate some changes to your `HelmRelease` resources.

diff --git a/docs/references/helmrelease-custom-resource.md b/docs/references/helmrelease-custom-resource.md
@@ -1,4 +1,13 @@
 # `HelmRelease` Custom Resource
+
+> **🛑 Upgrade Advisory**
+>
+> This documentation is for Helm Operator (v1) which has [reached its end-of-life in November 2022](https://fluxcd.io/blog/2022/10/september-2022-update/#flux-legacy-v1-retirement-plan).
+>
+> We strongly recommend you familiarise yourself with the newest Flux and [migrate as soon as possible](https://fluxcd.io/flux/migration/).
+>
+> For documentation regarding the latest Flux, please refer to [this section](https://fluxcd.io/flux/).
+
 <p>Packages:</p>
 <ul class="simple">
 <li>

diff --git a/docs/references/monitoring.md b/docs/references/monitoring.md
@@ -1,5 +1,13 @@
 # Monitoring
 
+> **🛑 Upgrade Advisory**
+>
+> This documentation is for Helm Operator (v1) which has [reached its end-of-life in November 2022](https://fluxcd.io/blog/2022/10/september-2022-update/#flux-legacy-v1-retirement-plan).
+>
+> We strongly recommend you familiarise yourself with the newest Flux and [migrate as soon as possible](https://fluxcd.io/flux/migration/).
+>
+> For documentation regarding the latest Flux, please refer to [this section](https://fluxcd.io/flux/).
+
 The Helm Operator exposes a metrics endpoint at `/metrics` on the configured
 [`--listen`](operator.md#general-flags) address (defaults to `:3030`) with data
 in Prometheus format.

diff --git a/docs/references/operator.md b/docs/references/operator.md
@@ -1,5 +1,13 @@
 # Operator reference
 
+> **🛑 Upgrade Advisory**
+>
+> This documentation is for Helm Operator (v1) which has [reached its end-of-life in November 2022](https://fluxcd.io/blog/2022/10/september-2022-update/#flux-legacy-v1-retirement-plan).
+>
+> We strongly recommend you familiarise yourself with the newest Flux and [migrate as soon as possible](https://fluxcd.io/flux/migration/).
+>
+> For documentation regarding the latest Flux, please refer to [this section](https://fluxcd.io/flux/).
+
 The Helm Operator deals with Helm chart releases. The operator watches for
 changes of Custom Resources of kind `HelmRelease`. It receives Kubernetes
 Events and acts accordingly.

diff --git a/docs/troubleshooting.md b/docs/troubleshooting.md
@@ -1,5 +1,13 @@
 # Troubleshooting
 
+> **🛑 Upgrade Advisory**
+>
+> This documentation is for Helm Operator (v1) which has [reached its end-of-life in November 2022](https://fluxcd.io/blog/2022/10/september-2022-update/#flux-legacy-v1-retirement-plan).
+>
+> We strongly recommend you familiarise yourself with the newest Flux and [migrate as soon as possible](https://fluxcd.io/flux/migration/).
+>
+> For documentation regarding the latest Flux, please refer to [this section](https://fluxcd.io/flux/).
+
 Also see the [issues labeled with
 `question`](https://github.com/fluxcd/helm-operator/labels/question), which often
 explain workarounds.