Skip to content

Commit 84df625

Browse files
Spruce up availability guidance (#594)
Co-authored-by: shainaraskas <[email protected]>
1 parent 3d27356 commit 84df625

File tree

1 file changed

+77
-15
lines changed

1 file changed

+77
-15
lines changed

get-started/versioning-availability.md

Lines changed: 77 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -18,30 +18,92 @@ It's important to understand this versioning system, for compatibility and [upgr
1818

1919
## Availability of features
2020

21-
Elastic products and features have different availability states across deployment types:
22-
23-
- **Generally Available**: Feature is production-ready (default if not specified)
24-
- **Beta**: Feature is nearing general availability but is not yet ready for production usage
25-
- **Technical preview**: Feature is in early development
26-
- **Coming**: Feature is announced for a future release
27-
- **Discontinued**: Feature is being phased out
28-
- **Unavailable**: Feature is not supported in this deployment type or version
21+
Elastic products and features have different availability states across deployment types and lifecycle stages.
2922

3023
Features may have different availability states between:
3124

32-
- Elastic Stack versions (for example, 9.0, 9.1)
33-
- Serverless projects (Security, {{es}}, Observability)
34-
- Deployment types (and versions)
25+
- **Deployment type**: The environment where the feature is available (Stack, Serverless, ECE, ECK, etc.)
26+
- **Lifecycle state**: The development or support status of the feature (GA, Beta, etc.)
27+
- **Version**: The specific version the lifecycle state applies to
28+
29+
#### Lifecycle states
30+
31+
| State | Description |
32+
|-------|-------------|
33+
| **Generally Available (GA)** | Production-ready feature (default if not specified) |
34+
| **Beta** | Feature is nearing general availability but not yet production-ready |
35+
| **Technical preview** | Feature is in early development stage |
36+
| **Coming** | Feature announced for a future release |
37+
| **Discontinued** | Feature is being phased out |
38+
| **Unavailable** | Feature is not supported in this deployment type or version |
39+
40+
### Where feature availability may differ
41+
42+
Features may have different states between:
43+
44+
- **[Elastic Stack](the-stack.md)** versions (e.g., 9.0, 9.1)
45+
- **Deployment types** (and deployment versions)
3546
- [Elastic Cloud Hosted](/deploy-manage/deploy/elastic-cloud/cloud-hosted.md)
3647
- [Elastic Cloud Serverless](/deploy-manage/deploy/elastic-cloud/serverless.md)
3748
- [Self-managed deployments](/deploy-manage/deploy/self-managed.md)
3849
- [Elastic Cloud Enterprise (ECE)](/deploy-manage/deploy/cloud-enterprise.md)
3950
- ECE deployment versions (for example, 4.0.0)
4051
- [Elastic Cloud on Kubernetes (ECK)](/deploy-manage/deploy/cloud-on-k8s.md)
4152
- ECK deployment versions (for example, 3.0.0)
53+
- **Serverless project types**
54+
- Security
55+
- Elasticsearch
56+
- Observability
57+
58+
### Important tips when reading the docs
59+
60+
- Always check feature lifecycle state for your specific deployment type and version
61+
- Pay attention to Elastic Stack version requirements
62+
- Note that Serverless features may vary by project type
63+
64+
### Availability badges in the docs
65+
66+
Our documentation uses badges to help you quickly identify where and when features are available for your specific environment.
67+
68+
Badges can appear in two places:
69+
1. **Page headers**: Shows the overall availability across all deployment types
70+
2. **Section headers**: Indicates specific availability for content in that section
71+
72+
### How to read the badges
73+
74+
Here are some examples to help you understand how to read the availability badges.
75+
76+
#### Example #1: Stack only feature
77+
78+
```yaml {applies_to}
79+
stack: ga 9.1
80+
```
81+
- **Deployment type**: Elastic Stack
82+
- **Version**: 9.1
83+
- **Lifecycle**: Generally Available (GA) — default state
84+
85+
#### Example #2: Serverless-only feature with project differences
86+
87+
```yaml {applies_to}
88+
serverless:
89+
security: beta
90+
elasticsearch: ga
91+
```
92+
- **Deployment type**: Serverless
93+
- **Lifecycle**:
94+
- Beta for Security projects
95+
- Generally Available for Elasticsearch projects
96+
97+
#### Example #3: Discontinued feature on one deployment type
4298
43-
When reading the Elastic documentation be sure to:
99+
```yaml {applies_to}
100+
deployment:
101+
ece: discontinued 4.1.0
102+
```
103+
- **Deployment type**: Elastic Cloud Enterprise
104+
- **Lifecycle**: Discontinued
105+
- **Version**: 4.1.0
44106
45-
- Check feature availability for your deployment type and version
46-
- Note stack version requirements
47-
- Be aware that Serverless features may vary by project type
107+
:::{tip}
108+
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.
109+
:::

0 commit comments

Comments
 (0)