Browse Source

fix: update deprecation policy, add link to support policy

Moritz Johner 4 years ago
parent
commit
d3c8b76cd3
3 changed files with 11 additions and 9 deletions
  1. 1 1
      README.md
  2. 1 1
      docs/deprecation-policy.md
  3. 9 7
      docs/stability-support.md

+ 1 - 1
README.md

@@ -23,7 +23,7 @@ Multiple people and organizations are joining efforts to create a single Externa
 
 ## Documentation
 
-External Secrets Operator guides and reference documentation is available at [external-secrets.io](https://external-secrets.io).
+External Secrets Operator guides and reference documentation is available at [external-secrets.io](https://external-secrets.io). Also see our [stability and support](https://external-secrets.io/latest/stability-support/) policy.
 
 ## Contributing
 

+ 1 - 1
docs/deprecation-policy.md

@@ -2,7 +2,7 @@
 
 We follow the [Kubernetes Deprecation Policy](https://kubernetes.io/docs/reference/using-api/deprecation-policy/) and [API Versioning Scheme](https://kubernetes.io/docs/reference/using-api/#api-versioning): alpha, beta, GA.
 
-The project is currently in `alpha` state. We track `beta` progress in [this GitHub Project](https://github.com/external-secrets/external-secrets/projects/3). Please try the `alpha` and `beta` features and provide feedback. After the features exit beta, it may not be practical to make more changes.
+The project is currently in `beta` state. Please try the `beta` features and provide feedback. After the features exits beta, it may not be practical to make more changes.
 
 * alpha
     * The support for a feature may be dropped at any time without notice.

+ 9 - 7
docs/stability-support.md

@@ -1,8 +1,8 @@
-This page lists the status, timeline and policy for currently supported ESO releases its providers.
+This page lists the status, timeline and policy for currently supported ESO releases and its providers. Please also see our [deprecation policy](deprecation-policy.md) that describes API versioning, deprecation and API surface.
 
 ## External Secrets Operator
 
-We are currently in beta and support only the latest release.
+We are currently in beta and support **only the latest release** for the time being.
 
 | ESO Version | Kubernetes Version |
 | ----------- | ------------------ |
@@ -12,12 +12,14 @@ We are currently in beta and support only the latest release.
 
 ## Provider Stability and Support Level
 
-| Provider                                                                                          | Stability |                                                                                                                                                                   Contact |
+The following table describes the stability level of each provider and who's responsible.
+
+| Provider                                                                                          | Stability |                                                                                                                                                                   Maintainer |
 | ------------------------------------------------------------------------------------------------- | :-------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
-| [AWS Secrets Manager](https://external-secrets.io/latest/provider-aws-secrets-manager/)           |  stable   |                                                                                                                     [ESO Maintained](https://github.com/external-secrets) |
-| [AWS Parameter Store](https://external-secrets.io/latest/provider-aws-parameter-store/)           |  stable   |                                                                                                                     [ESO Maintained](https://github.com/external-secrets) |
-| [Hashicorp Vault](https://external-secrets.io/latest/provider-hashicorp-vault/)                   |  stable   |                                                                                                                     [ESO Maintained](https://github.com/external-secrets) |
-| [GCP Secret Manager](https://external-secrets.io/latest/provider-google-secrets-manager/)         |  stable   |                                                                                                                     [ESO Maintained](https://github.com/external-secrets) |
+| [AWS Secrets Manager](https://external-secrets.io/latest/provider-aws-secrets-manager/)           |  stable   |                                                                                                                     [external-secrets](https://github.com/external-secrets) |
+| [AWS Parameter Store](https://external-secrets.io/latest/provider-aws-parameter-store/)           |  stable   |                                                                                                                     [external-secrets](https://github.com/external-secrets) |
+| [Hashicorp Vault](https://external-secrets.io/latest/provider-hashicorp-vault/)                   |  stable   |                                                                                                                     [external-secrets](https://github.com/external-secrets) |
+| [GCP Secret Manager](https://external-secrets.io/latest/provider-google-secrets-manager/)         |  stable   |                                                                                                                     [external-secrets](https://github.com/external-secrets) |
 | [Azure Keyvault](https://external-secrets.io/latest/provider-azure-key-vault/)                    |   beta    | [@ahmedmus-1A](https://github.com/ahmedmus-1A) [@asnowfix](https://github.com/asnowfix) [@ncourbet-1A](https://github.com/ncourbet-1A) [@1A-mj](https://github.com/1A-mj) |
 | [IBM Secrets Manager](https://external-secrets.io/latest/provider-ibm-secrets-manager/)           |   alpha   |                            [@knelasevero](https://github.com/knelasevero) [@sebagomez](https://github.com/sebagomez) [@ricardoptcosta](https://github.com/ricardoptcosta) |
 | [Yandex Lockbox](https://external-secrets.io/latest/provider-yandex-lockbox/)                     |   alpha   |                                                                       [@AndreyZamyslov](https://github.com/AndreyZamyslov) [@knelasevero](https://github.com/knelasevero) |