Browse Source

docs: Fix formatting in Deprecation Policy notes (#4791)

* docs: Fix formatting in Deprecation Policy notes

Signed-off-by: Kingdon B <kingdon@urmanac.com>

* docs: Fix grammar and formatting errors, spelling

Signed-off-by: Kingdon B <kingdon@urmanac.com>

---------

Signed-off-by: Kingdon B <kingdon@urmanac.com>
Kingdon Barrett 11 months ago
parent
commit
137e446ff6
2 changed files with 9 additions and 7 deletions
  1. 4 3
      DEPRECATING.md
  2. 5 4
      docs/introduction/deprecation-policy.md

+ 4 - 3
DEPRECATING.md

@@ -18,7 +18,7 @@ Secret](https://kubernetes.io/docs/concepts/configuration/secret/).
 
 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 `beta` state. Please try the `beta` features and provide feedback. After the features exits 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 exit beta, it may not be practical to make more changes.
 
 * alpha
     * The support for a feature may be dropped at any time without notice.
@@ -49,7 +49,8 @@ We define the following scope that is covered by our deprecation policy. We foll
 ### Non-Scope
 Everything not listed in scope is not subject to this deprecation policy and it is subject to breaking changes, updates at any point in time, and deprecation - **as long as it follows the Deprecation Process listed below**.
 
-This includes, but isn't limited to :
+This includes, but isn't limited to:
+
 * Any feature / specific behavior not in Scope.
 * Source code imports
 * Helm Charts
@@ -105,4 +106,4 @@ The release notes must prominently include:
 ### Full Deprecation and Removal
 
 When a deprecated feature is removed, it must be communicated in the release notes of the removal version.
-The removal must follow standard Kubernetes deprecation timelines if the feature is in scope.
+The removal must follow standard Kubernetes deprecation timelines if the feature is in scope.

+ 5 - 4
docs/introduction/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 `beta` state. Please try the `beta` features and provide feedback. After the features exits 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 exit beta, it may not be practical to make more changes.
 
 * alpha
     * The support for a feature may be dropped at any time without notice.
@@ -33,7 +33,8 @@ We define the following scope that is covered by our deprecation policy. We foll
 ### Non-Scope
 Everything not listed in scope is not subject to this deprecation policy and it is subject to breaking changes, updates at any point in time, and deprecation - **as long as it follows the Deprecation Process listed below**.
 
-This includes, but insn't limited to :
+This includes, but isn't limited to:
+
 * Any feature / specific behavior not in Scope.
 * Source code imports
 * Helm Charts
@@ -42,6 +43,6 @@ This includes, but insn't limited to :
 * Image Signature (including provenance, providers, keys)
 * OLM-specific builds
 
-## Depreaction Process:
+## Deprecation Process:
 
-Deprecation process is described within the [project github repository](https://github.com/external-secrets/external-secrets/blob/main/DEPRECATING.md)
+Deprecation process is described within the [project GitHub repository](https://github.com/external-secrets/external-secrets/blob/main/DEPRECATING.md)