From 779a87e1c9fa3b602eb034afab14bad5a6b08e59 Mon Sep 17 00:00:00 2001 From: Liam Thompson Date: Tue, 25 Feb 2025 14:16:01 +0100 Subject: [PATCH 1/5] Spruce up availability guidance --- get-started/versioning-availability.md | 97 +++++++++++++++++++++----- 1 file changed, 79 insertions(+), 18 deletions(-) diff --git a/get-started/versioning-availability.md b/get-started/versioning-availability.md index fb859ed04f..d5e6acc11c 100644 --- a/get-started/versioning-availability.md +++ b/get-started/versioning-availability.md @@ -16,32 +16,93 @@ Each number represents a specific level of change: It's important to understand this versioning system, for compatibility and [upgrade](/deploy-manage/upgrade.md) planning. -## Availability of features +## Understanding availability in the docs -Elastic products and features have different availability states across deployment types: +Elastic products and features have different availability states across deployment types and lifecycle stages. Our documentation uses special badges to help you quickly identify where and when features are available for your specific environment. -- **Generally Available**: Feature is production-ready (default if not specified) -- **Beta**: Feature is nearing general availability but is not yet ready for production usage -- **Technical preview**: Feature is in early development -- **Coming**: Feature is announced for a future release -- **Discontinued**: Feature is being phased out -- **Unavailable**: Feature is not supported in this deployment type or version +### What the badges mean -Features may have different availability states between: +Each badge provides up to three key pieces of information: -- Elastic Stack versions (for example, 9.0, 9.1) -- Serverless projects (Security, {{es}}, Observability) -- Deployment types (and versions) +- **Deployment type**: The environment where the feature is available (Stack, ECE, ECK, etc.) +- **Lifecycle state**: The development or support status of the feature (GA, Beta, etc.) +- **Version**: The specific version the lifecycle state applies to + +#### Lifecycle states + +| State | Description | +|-------|-------------| +| **Generally Available (GA)** | Production-ready feature (default if not specified) | +| **Beta** | Feature is nearing general availability but not yet production-ready | +| **Technical preview** | Feature is in early development stage | +| **Coming** | Feature announced for a future release | +| **Discontinued** | Feature is being phased out | +| **Unavailable** | Feature is not supported in this deployment type or version | + +### Badge context + +Badges can appear in two places: +1. **Page headers**: Shows the overall availability across all deployment types +2. **Section headers**: Indicates specific availability for content in that section + +### Where feature availability may differ + +Features may have different lifecycle states between: + +- **[Elastic Stack](the-stack.md)** versions (e.g., 9.0, 9.1) +- **Serverless projects**: + - Security + - Elasticsearch + - Observability +- **Deployment types**: - [Elastic Cloud Hosted](/deploy-manage/deploy/elastic-cloud/cloud-hosted.md) - [Elastic Cloud Serverless](/deploy-manage/deploy/elastic-cloud/serverless.md) - [Self-managed deployments](/deploy-manage/deploy/self-managed.md) - [Elastic Cloud Enterprise (ECE)](/deploy-manage/deploy/cloud-enterprise.md) - - ECE deployment versions (for example, 4.0.0) - [Elastic Cloud on Kubernetes (ECK)](/deploy-manage/deploy/cloud-on-k8s.md) - - ECK deployment versions (for example, 3.0.0) -When reading the Elastic documentation be sure to: +### How to read the badges + +Here are some examples to help you understand how to read the availability badges. + +#### Example #1: Stack only feature + +```yaml {applies_to} +stack: ga 9.1 +``` +- **Deployment type**: Elastic Stack +- **Version**: 9.1 +- **Lifecycle**: Generally Available (GA) + +#### Example #2: Serverless-only feature with project differences + +```yaml {applies_to} +serverless: + security: beta + elasticsearch: ga +``` +- **Deployment type**: Serverless +- **Lifecycle**: + - Beta for Security porjects + - Generally Available for Elasticsearch projects + +#### Example #3: Discontinued feature on one deployment type + +```yaml {applies_to} +deployment: + ece: discontinued 9.2.0 +``` +- **Deployment type**: Elastic Cloud Enterprise +- **Lifecycle**: Discontinued +- **Version**: 9.2.0 + +### Important tips when reading documentation + +- Always check feature lifecycle state for your specific deployment type and version +- Pay attention to Elastic Stack version requirements +- Note that Serverless features may vary by project type +- Features without badges are generally available for all deployment types and versions -- Check feature availability for your deployment type and version -- Note stack version requirements -- Be aware that Serverless features may vary by project type \ No newline at end of file +:::{tip} +For contributors and those interested in the technical details, see the [Elastic docs syntax guide](https://elastic.github.io/docs-builder/syntax/applies/) for more information on how these badges are implemented. +::: \ No newline at end of file From 512f527e18912ed1903f254a8516a509fea7400b Mon Sep 17 00:00:00 2001 From: Liam Thompson Date: Tue, 25 Feb 2025 14:22:41 +0100 Subject: [PATCH 2/5] Tweak, clean, restore bathwater --- get-started/versioning-availability.md | 22 ++++++++++++---------- 1 file changed, 12 insertions(+), 10 deletions(-) diff --git a/get-started/versioning-availability.md b/get-started/versioning-availability.md index d5e6acc11c..8c19f7911b 100644 --- a/get-started/versioning-availability.md +++ b/get-started/versioning-availability.md @@ -18,13 +18,13 @@ It's important to understand this versioning system, for compatibility and [upgr ## Understanding availability in the docs -Elastic products and features have different availability states across deployment types and lifecycle stages. Our documentation uses special badges to help you quickly identify where and when features are available for your specific environment. +Elastic products and features have different availability states across deployment types and lifecycle stages. Our documentation uses badges to help you quickly identify where and when features are available for your specific environment. ### What the badges mean Each badge provides up to three key pieces of information: -- **Deployment type**: The environment where the feature is available (Stack, ECE, ECK, etc.) +- **Deployment type**: The environment where the feature is available (Stack, Serverless ECE, ECK, etc.) - **Lifecycle state**: The development or support status of the feature (GA, Beta, etc.) - **Version**: The specific version the lifecycle state applies to @@ -47,19 +47,21 @@ Badges can appear in two places: ### Where feature availability may differ -Features may have different lifecycle states between: +Features may have different states between: - **[Elastic Stack](the-stack.md)** versions (e.g., 9.0, 9.1) -- **Serverless projects**: - - Security - - Elasticsearch - - Observability -- **Deployment types**: +- **Deployment types** (and deployment versions) - [Elastic Cloud Hosted](/deploy-manage/deploy/elastic-cloud/cloud-hosted.md) - [Elastic Cloud Serverless](/deploy-manage/deploy/elastic-cloud/serverless.md) - [Self-managed deployments](/deploy-manage/deploy/self-managed.md) - [Elastic Cloud Enterprise (ECE)](/deploy-manage/deploy/cloud-enterprise.md) + - ECE deployment versions (for example, 4.0.0) - [Elastic Cloud on Kubernetes (ECK)](/deploy-manage/deploy/cloud-on-k8s.md) + - ECK deployment versions (for example, 3.0.0) +- **Serverless project types** + - Security + - Elasticsearch + - Observability ### How to read the badges @@ -72,7 +74,7 @@ stack: ga 9.1 ``` - **Deployment type**: Elastic Stack - **Version**: 9.1 -- **Lifecycle**: Generally Available (GA) +- **Lifecycle**: Generally Available (GA) — default state #### Example #2: Serverless-only feature with project differences @@ -83,7 +85,7 @@ serverless: ``` - **Deployment type**: Serverless - **Lifecycle**: - - Beta for Security porjects + - Beta for Security projects - Generally Available for Elasticsearch projects #### Example #3: Discontinued feature on one deployment type From e8186d0beefbfb837c9ce3656d78184c8977e68f Mon Sep 17 00:00:00 2001 From: Liam Thompson Date: Tue, 25 Feb 2025 15:21:13 +0100 Subject: [PATCH 3/5] Add comma --- get-started/versioning-availability.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/get-started/versioning-availability.md b/get-started/versioning-availability.md index 8c19f7911b..b4c00cb665 100644 --- a/get-started/versioning-availability.md +++ b/get-started/versioning-availability.md @@ -24,7 +24,7 @@ Elastic products and features have different availability states across deployme Each badge provides up to three key pieces of information: -- **Deployment type**: The environment where the feature is available (Stack, Serverless ECE, ECK, etc.) +- **Deployment type**: The environment where the feature is available (Stack, Serverless, ECE, ECK, etc.) - **Lifecycle state**: The development or support status of the feature (GA, Beta, etc.) - **Version**: The specific version the lifecycle state applies to From b336cf136a254596dd52371cf444569abcef3c06 Mon Sep 17 00:00:00 2001 From: Liam Thompson Date: Tue, 25 Feb 2025 15:53:35 +0100 Subject: [PATCH 4/5] decouple availability and info and badge explanation --- get-started/versioning-availability.md | 35 +++++++++++++------------- 1 file changed, 17 insertions(+), 18 deletions(-) diff --git a/get-started/versioning-availability.md b/get-started/versioning-availability.md index b4c00cb665..8776aa1d1e 100644 --- a/get-started/versioning-availability.md +++ b/get-started/versioning-availability.md @@ -16,13 +16,11 @@ Each number represents a specific level of change: It's important to understand this versioning system, for compatibility and [upgrade](/deploy-manage/upgrade.md) planning. -## Understanding availability in the docs +## Availability of features -Elastic products and features have different availability states across deployment types and lifecycle stages. Our documentation uses badges to help you quickly identify where and when features are available for your specific environment. +Elastic products and features have different availability states across deployment types and lifecycle stages. -### What the badges mean - -Each badge provides up to three key pieces of information: +Features may have different availability states between: - **Deployment type**: The environment where the feature is available (Stack, Serverless, ECE, ECK, etc.) - **Lifecycle state**: The development or support status of the feature (GA, Beta, etc.) @@ -39,12 +37,6 @@ Each badge provides up to three key pieces of information: | **Discontinued** | Feature is being phased out | | **Unavailable** | Feature is not supported in this deployment type or version | -### Badge context - -Badges can appear in two places: -1. **Page headers**: Shows the overall availability across all deployment types -2. **Section headers**: Indicates specific availability for content in that section - ### Where feature availability may differ Features may have different states between: @@ -63,6 +55,20 @@ Features may have different states between: - Elasticsearch - Observability +### Important tips when reading the docs + +- Always check feature lifecycle state for your specific deployment type and version +- Pay attention to Elastic Stack version requirements +- Note that Serverless features may vary by project type + +### Availability badges in the docs + +Our documentation uses badges to help you quickly identify where and when features are available for your specific environment. + +Badges can appear in two places: +1. **Page headers**: Shows the overall availability across all deployment types +2. **Section headers**: Indicates specific availability for content in that section + ### How to read the badges Here are some examples to help you understand how to read the availability badges. @@ -98,13 +104,6 @@ deployment: - **Lifecycle**: Discontinued - **Version**: 9.2.0 -### Important tips when reading documentation - -- Always check feature lifecycle state for your specific deployment type and version -- Pay attention to Elastic Stack version requirements -- Note that Serverless features may vary by project type -- Features without badges are generally available for all deployment types and versions - :::{tip} For contributors and those interested in the technical details, see the [Elastic docs syntax guide](https://elastic.github.io/docs-builder/syntax/applies/) for more information on how these badges are implemented. ::: \ No newline at end of file From 19479f66255905f3e703181d407833f238733285 Mon Sep 17 00:00:00 2001 From: Liam Thompson <32779855+leemthompo@users.noreply.github.com> Date: Tue, 25 Feb 2025 16:38:06 +0100 Subject: [PATCH 5/5] Update get-started/versioning-availability.md Co-authored-by: shainaraskas <58563081+shainaraskas@users.noreply.github.com> --- get-started/versioning-availability.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/get-started/versioning-availability.md b/get-started/versioning-availability.md index 8776aa1d1e..c427dcbfa0 100644 --- a/get-started/versioning-availability.md +++ b/get-started/versioning-availability.md @@ -98,11 +98,11 @@ serverless: ```yaml {applies_to} deployment: - ece: discontinued 9.2.0 + ece: discontinued 4.1.0 ``` - **Deployment type**: Elastic Cloud Enterprise - **Lifecycle**: Discontinued -- **Version**: 9.2.0 +- **Version**: 4.1.0 :::{tip} For contributors and those interested in the technical details, see the [Elastic docs syntax guide](https://elastic.github.io/docs-builder/syntax/applies/) for more information on how these badges are implemented.