Fix YAML formatting and add link (kubernetes#36)

* Fix YAML formatting and add link * Add features.yaml checkbox
howardjohn · Apr 19, 2021 · 21e3d9b · 21e3d9b
1 parent 23e8e7d
commit 21e3d9b
Show file tree

Hide file tree

Showing 3 changed files with 236 additions and 189 deletions.
diff --git a/FEATURES.md b/FEATURES.md
@@ -2,8 +2,7 @@
 
 Maturity of features in Istio indicate to users what they can [expect](https://istio.io/latest/about/feature-stages/) by using these
 features. In Istio, we track these requirements using a [template](features/feature_template.md). Once all
-requirements for promoting a feature to the next level are met, the [features](features.yaml)
-file may be updated to indicate this maturity level.
+requirements for the next level are met, [features.yaml](features.yaml) can be updated in order to promote the feature.
 
 ## Features.yaml
 
@@ -14,21 +13,23 @@ entry as described below.
 
 ```
 features:
-  - name: "Protocols:HTTP1.1/HTTP2/gRPC/TCP"
+- name: "Stackdriver Integration"
+    link: "/docs/reference/config/proxy_extensions/stackdriver/"
     level:
-      - checkList: 
-        maturity:
-        nextExpectedPromotion:
-        area: Core 
-	deprecation:
-      - state:
-        begin:
-        details:
-		- replacement: 
+      checklist: ""
+      maturity: Stable
+      nextExpectedPromotion: ""
+    deprecation:
+      state: "deprecated"
+      details:
+        replacement: "SelfDrivingStack integration"
+        next: "1.10"
+    area:  Observability
 ```
 
-* **Name** indicates the name of the feature.
-* **Area** indicates the area of the feature.
+* **name** indicates the name of the feature.
+* **area** indicates the area of the feature.
+* **link** indicates a primary link that users can navigate to in order to find out more about a feature. This link may be provided to users by tooling consuming features.yaml.
 * **level** indicates the maturity level of a feature.
 * **level.checklist** is the path to the checklist to track a feature's maturity.
 * **level.maturity** is the current maturity level of the feature. This can be `experimental`, `alpha`, `beta`, or `stable`. Experimental is an optional maturity level that can be skipped. For alpha, beta, and stable, all requirements for the previous levels must be met before a feature can meet the next level (i.e. a stable feature has met the requirements of both alpha and beta). There may be features for which a requirement is not applicable.