Add docs about API stabilitly and deprecation policy (#661)

Signed-off-by: Priya Wadhwa <priya@chainguard.dev>
sigstore · Feb 10, 2022 · 55a1978 · 55a1978
1 parent 5ff6663
commit 55a1978
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 0 deletions.
diff --git a/DEPRECATIONS.md b/DEPRECATIONS.md
@@ -0,0 +1,10 @@
+# Deprecations
+
+This doc lists deprecated features in `rekor`.
+You can read more about Sigstore's deprecation policy [here](https://docs.sigstore.dev/api-stability)!
+
+| **Feature Being Deprecated** | **API Stability Level** | **Earliest Date of Removal** |
+|------------------------------|-------------------------|------------------------------|
+| My feature                   | Experimental/Beta/GA    | DD/MM/YY                     |
+|                              |                         |                              |
+|                              |                         |                              |
diff --git a/FEATURES.md b/FEATURES.md
@@ -0,0 +1,14 @@
+# Feature Stability
+
+This doc covers feature stability in `rekor` as described in the [API Stability Policy](https://docs.sigstore.dev/api-stability) for Sigstore.
+
+## Experimental
+
+
+## Beta
+* Rekor API, defined [here](https://github.com/sigstore/rekor/blob/main/openapi.yaml)
+* The Rekor RFC 3161 timestamping service
+* `rekor-cli` CLI tool
+* The `rekor/pkg/client` client library
+
+## General Availability