Skip to content

Commit e661950

Browse files
KOTungsethCopilotbmorelli25
authored
Updates release notes and versioning to clarify 9.1.0 (#2317)
- Clarifies the release notes landing page for 9.1.0 - Turns Understanding versioning and availability into an FAQ --------- Co-authored-by: Copilot <[email protected]> Co-authored-by: Brandon Morelli <[email protected]>
1 parent 602cc48 commit e661950

File tree

3 files changed

+186
-123
lines changed

3 files changed

+186
-123
lines changed

docset.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@ exclude:
99
- 'raw-migrated-files/**'
1010

1111
cross_links:
12+
- apm-agent-android
13+
- apm-agent-ios
1214
- apm-agent-dotnet
1315
- apm-agent-go
1416
- apm-agent-java
@@ -30,6 +32,8 @@ cross_links:
3032
- ecs-dotnet
3133
- ecs-logging
3234
- ecs-logging-go-zap
35+
- ecs-logging-go-zerolog
36+
- ecs-logging-go-logrus
3337
- ecs-logging-java
3438
- ecs-logging-nodejs
3539
- ecs-logging-php

get-started/versioning-availability.md

Lines changed: 160 additions & 116 deletions
Original file line numberDiff line numberDiff line change
@@ -4,168 +4,212 @@ mapped_pages:
44
- https://www.elastic.co/guide/en/starting-with-the-elasticsearch-platform-and-its-solutions/current/introducing-elastic-documentation.html
55
products:
66
- id: elastic-stack
7+
description: Learn how Elastic handles versioning and feature availability in the docs. Find the product versions that are supported, how to read availability badges, and...
78
---
89

9-
# Understanding versioning and availability
10+
# Versioning and availability in Elastic Docs
1011

11-
On this page, you'll learn about our versioning systems, how to understand how we talk about versions and feature availability in our documentation, and where to find docs for your product version.
12+
Learn how Elastic Docs handles versioning, feature availability, and how to find the right documentation for your deployment type and product version. Find answers to common questions about the Elastic Stack versioning and confidently navigate our continuously updated documentation.
1213

13-
## Elastic Stack versioning
14+
## Frequently asked questions
1415

15-
{{es}} and the core components of the Elastic Stack use a semantic versioning scheme. This scheme consists of three numbers separated by periods in the form `X.Y.Z`, for example: `9.0.0`.
16+
### Where can I find documentation for the latest version of the {{stack}}?
1617

17-
Each number represents a specific level of change:
18+
You’re in the right place! All documentation for Elastic Stack 9.0.0 and later is available at [elastic.co/docs](https://www.elastic.co/docs), including the latest {{version.stack| M.M}} version and any future versions in the 9.x series.
1819

19-
- **Major (X)**: Indicates significant changes, such as new features, breaking changes, and major enhancements. Upgrading to a new major version may require changes to your existing setup and configurations.
20-
- **Minor (Y)**: Introduces new features and improvements, while maintaining backward compatibility with the previous minor versions within the same major version. Upgrading to a new minor version should not require any changes to your existing setup.
21-
- **Patch (Z)**: Contains bug fixes and security updates, without introducing new features or breaking changes. Upgrading to a new patch version should be seamless and not require any changes to your existing setup.
20+
Need docs for an earlier version? Go to [elastic.co/guide](https://www.elastic.co/guide).
2221

23-
It's important to understand this versioning system, for compatibility and [upgrade](/deploy-manage/upgrade.md) planning.
22+
### Why doesn't Elastic have separate documentation for each version?
2423

25-
## Availability of features
24+
Starting with {{stack}} 9.0.0, Elastic no longer publishes separate documentation sets for each minor release. Instead, all changes in the 9.x series are included in a single, continuously updated documentation set.
2625

27-
Elastic products and features have different availability states across deployment types and lifecycle stages.
26+
This approach helps:
27+
* Reduce duplicate pages
28+
* Show the full history and context of a feature
29+
* Simplify search and navigation
2830

29-
Features may have different availability states between:
31+
### How do I know content was added in a specific version?
3032

31-
- **Deployment type**: The environment where the feature is available (Stack, Serverless, ECE, ECK, etc.)
32-
- **Lifecycle state**: The development or support status of the feature (GA, Beta, etc.)
33-
- **Version**: The specific version the lifecycle state applies to
33+
We clearly mark content added or changed in a specific version using availability badges. The availability badges appear in page headers, section headers, and inline.
3434

35-
#### Lifecycle states
35+
#### Elastic Stack example
3636

37-
| State | Description |
38-
|-------|-------------|
39-
| **Generally Available (GA)** | Production-ready feature (default if not specified) |
40-
| **Beta** | Feature is nearing general availability but not yet production-ready |
41-
| **Technical preview** | Feature is in early development stage |
42-
| **Unavailable** | Feature is not supported in this deployment type or version |
37+
```{applies_to}
38+
stack: ga 9.1
39+
```
4340

44-
### Where feature availability may differ
41+
This means the feature is:
42+
* Available on Elastic Stack
43+
* Generally Available (GA)
44+
* Introduced in version 9.1.0
4545

46-
Features may have different states between:
46+
#### Serverless example
4747

48-
- **[Elastic Stack](the-stack.md)** versions (e.g., 9.0, 9.1)
49-
- **Deployment types** (and deployment versions)
50-
- [Elastic Cloud Hosted](/deploy-manage/deploy/elastic-cloud/cloud-hosted.md)
51-
- [Elastic Cloud Serverless](/deploy-manage/deploy/elastic-cloud/serverless.md)
52-
- [Self-managed deployments](/deploy-manage/deploy/self-managed.md)
53-
- [Elastic Cloud Enterprise (ECE)](/deploy-manage/deploy/cloud-enterprise.md)
54-
- ECE deployment versions (for example, 4.0.0)
55-
- [Elastic Cloud on Kubernetes (ECK)](/deploy-manage/deploy/cloud-on-k8s.md)
56-
- ECK deployment versions (for example, 3.0.0)
57-
- **Serverless project types**
58-
- Security
59-
- Elasticsearch
60-
- Observability
48+
```{applies_to}
49+
serverless:
50+
security: beta
51+
elasticsearch: ga
52+
```
6153

62-
### Important tips when reading the docs
54+
This means the feature is:
55+
* Generally Available for {{es}} Serverless projects
56+
* Beta for {{elastic-sec}} Serverless projects
6357

64-
- Always check feature lifecycle state for your specific deployment type and version
65-
- Pay attention to Elastic Stack version requirements
66-
- Note that Serverless features may vary by project type
58+
#### Elastic Cloud Enterprise example
6759

68-
### Availability badges in the docs
60+
```{applies_to}
61+
deployment:
62+
ece: deprecated 4.1.0
63+
```
6964

70-
Our documentation uses badges to help you quickly identify where and when features are available for your specific environment.
65+
This means the feature is:
66+
* Available on {{ece}}
67+
* Deprecated starting in version 4.1.0
7168

72-
Badges can appear in two places:
73-
1. **Page headers**: Shows the overall availability across all deployment types
74-
2. **Section headers**: Indicates specific availability for content in that section
69+
:::{tip}
70+
Want to learn more about how availability badges are used? Check the [Elastic Docs syntax guide](https://elastic.github.io/docs-builder/syntax/applies/).
71+
:::
7572

76-
### How to read the badges
73+
### What if I'm using a version earlier than {{stack}} 9.0.0?
7774

78-
Here are some examples to help you understand how to read the availability badges.
75+
Documentation for {{stack}} 8.19.0 and earlier is available at [elastic.co/guide](https://www.elastic.co/guide).
7976

80-
#### Example #1: Stack-only feature
77+
If a previous version for a specific page exists, you can select the version from the dropdown in the page sidebar.
8178

82-
```yaml {applies_to}
83-
stack: ga 9.1
84-
```
85-
- **Deployment type**: Elastic Stack
86-
- **Version**: 9.1.0+
87-
- **Lifecycle**: Generally Available (GA) — default state
79+
### How often is the documentation updated?
8880

89-
#### Example #2: Serverless-only feature with project differences
81+
We frequently update Elastic Docs to reflect the following:
82+
* Minor versions, such as {{stack}} 9.1.0
83+
* Patch-level updates, such as {{stack}} 9.1.1
84+
* Ongoing improvements to clarify and expand guidance
9085

91-
```yaml {applies_to}
92-
serverless:
93-
security: beta
94-
elasticsearch: ga
95-
```
96-
- **Deployment type**: Serverless
97-
- **Lifecycle**:
98-
- Beta for Security projects
99-
- Generally Available for Elasticsearch projects
86+
To learn what's changed, check the [release notes](/release-notes/index.md) for each Elastic product.
10087

101-
#### Example #3: Deprecated feature on one deployment type
88+
### How do I know what the current {{stack}} version is?
10289

103-
```yaml {applies_to}
104-
deployment:
105-
ece: deprecated 4.1.0
106-
```
107-
- **Deployment type**: Elastic Cloud Enterprise
108-
- **Lifecycle**: Deprecated
109-
- **Version**: 4.1.0
90+
To make sure you're always viewing the most up-to-date and relevant documentation, the version dropdown at the top of each page shows the most recent 9.x release. For example, 9.0+.
11091

111-
:::{tip}
112-
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.
113-
:::
92+
## Understanding {{stack}} versioning
11493

115-
## Find docs for your product version
94+
{{stack}} uses semantic versioning in the `X.Y.Z` format, such as `9.0.0`.
11695

117-
In April 2025, we released our new documentation site. This site includes documentation for our latest product versions.
96+
| Version | Description |
97+
|-------|-------------|
98+
| **Major (X)** | Indicates significant changes, such as new features, breaking changes, and major enhancements. Upgrading to a new major version may require changes to your existing setup and configurations. |
99+
| **Minor (Y)** | Introduces new features and improvements, while maintaining backward compatibility with the previous minor versions within the same major version. Upgrading to a new minor version should not require any changes to your existing setup. |
100+
| **Patch (Z)** | Contains bug fixes and security updates, without introducing new features or breaking changes. Upgrading to a new patch version should be seamless and not require any changes to your existing setup. |
118101

119-
To access our previous documentation system, which contains the documentation for releases prior to those listed below, go to [elastic.co/guide](https://elastic.co/guide).
102+
Understanding {{stack}} versioning is essential for [upgrade planning](/deploy-manage/upgrade.md) and ensuring compatibility.
120103

121-
You can access the previous version of a specific page, where available, by clicking the **View previous version** link in the sidebar.
104+
## Availability of features
122105

123-
The following product versions are documented on this site:
106+
The features available to you can differ based on deployment type, product lifecycle stage, and specific version.
124107

125-
#### Core products and deployment methods
108+
### Feature availability factors
126109

127-
| Product | Version |
128-
| --- | --- |
129-
| {{stack}}<br><br>Includes {{es}}, {{kib}}, {{ls}}, {{fleet}}, <br>{{agent}}, Beats, APM, and query languages | 9.0.0+ |
130-
| Security solution | 9.0.0+ |
131-
| Observability solution | 9.0.0+ |
132-
| {{serverless-full}} (all project types) | All |
133-
| {{ech}} | All* |
134-
| {{ece}} | 4.0.0+ |
135-
| {{eck}} | 3.0.0+ |
110+
| Factor | Description |
111+
|-------|-------------|
112+
| **Deployment type** | The environment where the feature is available, for example, {{stack}}, {{serverless-full}}, {{ece}} (ECE), {{eck}} (ECK) |
113+
| **Lifecycle state** | The development or support status of the feature, for example, GA and Beta |
114+
| **Version** | The specific version the lifecycle state applies to |
115+
116+
### Lifecycle states
117+
118+
| Lifecycle state | Description |
119+
|-------|-------------|
120+
| **Generally Available (GA)** | Production-ready feature. When unspecified, GA is the default |
121+
| **Beta** | Feature is nearing general availability but not yet production-ready |
122+
| **Technical preview** | Feature is in early development stage |
123+
| **Unavailable** | Feature is not supported in this deployment type or version |
124+
125+
### Examples of where availability can vary
136126

137-
\* Excludes release notes before January 2025
127+
| Category | Example |
128+
|-------|-------------|
129+
| **Elastic Stack versions** | [Elastic Stack](the-stack.md) version 9.0.0 and later, including 9.1.0 |
130+
| **Deployment types** | [Elastic Cloud Serverless](/deploy-manage/deploy/elastic-cloud/serverless.md), [Elastic Cloud Hosted](/deploy-manage/deploy/elastic-cloud/cloud-hosted.md), [Elastic Cloud Enterprise (ECE)](/deploy-manage/deploy/cloud-enterprise.md), [Elastic Cloud on Kubernetes (ECK)](/deploy-manage/deploy/cloud-on-k8s.md), and [Self-managed deployments](/deploy-manage/deploy/self-managed.md) |
131+
| **Deployment versions** | [Elastic Cloud Enterprise (ECE)](/deploy-manage/deploy/cloud-enterprise.md) 4.0.0 and later, [Elastic Cloud on Kubernetes (ECK)](/deploy-manage/deploy/cloud-on-k8s.md) 3.0.0 and later |
132+
| **Serverless project types** | {{es}}, {{observability}}, and {{elastic-sec}}
133+
134+
## Find docs for your product version
135+
136+
Find the documentation for your Elastic product versions or releases.
138137

139-
#### Schemas, libraries, and tools
138+
### Elastic Stack product versions
140139

141140
| Product | Version |
142141
| --- | --- |
143-
| Elastic Common Schema | 9.0.0+ |
144-
| ECS logging Java library | 1.x+ |
145-
| Other ECS logging libraries | All |
146-
| {{es}} API clients | 9.0.0+ |
147-
| {{es}} for Apache Hadoop | 9.0.0+ |
148-
| Curator | 8.0+ |
149-
| Elastic Cloud Control (ECCTL) | 1.14+ |
150-
| Elastic Serverless Forwarder | All |
151-
| Elastic integrations | All |
152-
| Elastic Search UI library | All |
153-
154-
#### APM agents and tools
142+
| [Elasticsearch](elasticsearch://release-notes/index.md) | 9.0.0 and later |
143+
| [Kibana](kibana://release-notes/index.md) | 9.0.0 and later |
144+
| [Fleet and Elastic Agent](/release-notes/fleet-elastic-agent/index.md) | 9.0.0 and later |
145+
| [Logstash](logstash://release-notes/index.md) | 9.0.0 and later |
146+
| [Beats](beats://release-notes/index.md) | 9.0.0 and later |
147+
| [Elastic Observability](/release-notes/elastic-observability/index.md) | 9.0.0 and later |
148+
| [Elastic APM](apm-server://release-notes/index.md) | 9.0.0 and later |
149+
| [Elastic Security](/release-notes/elastic-security/index.md) | 9.0.0 and later |
150+
151+
### Deployment type versions or releases
152+
153+
| Product | Version or release |
154+
| --- | --- |
155+
| All [Elastic Cloud Serverless](/release-notes/elastic-cloud-serverless/index.md) project types | All releases |
156+
| [Elastic Cloud Hosted](cloud://release-notes/cloud-hosted/index.md) | All releases for January 2025 and later |
157+
| [Elastic Cloud Enterprise](cloud://release-notes/cloud-enterprise/index.md) | 4.0.0 and later |
158+
| [Elastic Cloud on Kubernetes](cloud-on-k8s://release-notes/index.md) | 3.0.0 and later |
159+
160+
### Schema, library, and tool versions
161+
162+
| Product | Version or release
163+
| --- | --- |
164+
| [Elasticsearch Java Client](elasticsearch-java://release-notes/index.md) | 9.0.0 and later |
165+
| [Elasticsearch JavaScript Client](elasticsearch-js://release-notes/index.md) | 9.0.0 and later |
166+
| [Elasticsearch .NET Client](elasticsearch-net://release-notes/index.md) | 9.0.0 and later |
167+
| [Elasticsearch PHP Client](elasticsearch-php://release-notes/index.md) | 9.0.0 and later |
168+
| [Elasticsearch Python Client](elasticsearch-py://release-notes/index.md) | 9.0.0 and later |
169+
| [Elasticsearch Ruby Client](elasticsearch-ruby://release-notes/index.md) | 9.0.0 and later |
170+
| [Elastic Common Schema (ECS)](ecs://release-notes/index.md) | 9.0.0 and later |
171+
| [ECS Logging .NET library](ecs-dotnet://reference/index.md) | 8.18.1 and later |
172+
| [ECS Logging Go (Logrus) library](ecs-logging-go-logrus://reference/index.md) | 1.0.0 and later |
173+
| [ECS Logging Go (Zap) library](ecs-logging-go-zap://reference/index.md) | 1.0.3 and later |
174+
| [ECS Logging Go (Zerolog) library](ecs-logging-go-zerolog://reference/index.md) | 0.2.0 and later |
175+
| [ECS Logging Java library](ecs-logging-java://reference/index.md) | 1.x and later |
176+
| [ECS Logging Node.js library](ecs-logging-nodejs://reference/index.md) | 1.5.3 and later |
177+
| [ECS Logging PHP library](ecs-logging-php://reference/index.md) | 2.0.0 and later |
178+
| [ECS Logging Python library](ecs-logging-python://reference/index.md) | 2.2.0 and later |
179+
| [ECS Logging Ruby library](ecs-logging-ruby://reference/index.md) | 1.0.0 and later |
180+
| [Elasticsearch for Apache Hadoop](elasticsearch-hadoop://release-notes/index.md) | 9.0.0 and later |
181+
| [Elasticsearch Curator](curator://reference/index.md) | 8.0.0 and later |
182+
| [Elastic Cloud Control (ECCTL)](ecctl://release-notes/index.md) | 1.14.0 and later |
183+
| [Elastic Serverless Forwarder for AWS](elastic-serverless-forwarder://reference/index.md) | 1.20.1 and later |
184+
| [Elastic integrations](https://www.elastic.co/docs/reference/integrations/all_integrations) | All versions |
185+
| [Search UI JavaScript library](search-ui://reference/index.md) | 1.24.0 and later |
186+
187+
### APM agent and tool versions
155188

156189
| Product | Version |
157190
| --- | --- |
158-
| APM Android agent | 1.x+ |
159-
| APM .NET agent | 1.x+ |
160-
| APM Go agent | 2.x+ |
161-
| APM iOS agent | 1.x+ |
162-
| APM Java agent | 1.x+ |
163-
| APM Node.js agent | 4.x+ |
164-
| APM PHP agent | All |
165-
| APM Python agent | 6.x+ |
166-
| APM Ruby agent | 4.x+ |
167-
| APM Real User Monitoring JavaScript agent | 5.x+ |
168-
| APM attacher for Kubernetes | All |
191+
| [Elastic Distribution of OpenTelemetry Android](apm-agent-android://release-notes/index.md) | 0.1.0 and later |
192+
| [Elastic Distribution of OpenTelemetry iOS](apm-agent-ios://release-notes/index.md) | 1.0.0 and later |
193+
| [Elastic Distribution of OpenTelemetry Java](elastic-otel-java://release-notes/index.md) | 1.0.0 and later |
194+
| [Elastic Distribution of OpenTelemetry .NET](elastic-otel-dotnet://release-notes/index.md) | 1.0.0 and later |
195+
| [Elastic Distribution of OpenTelemetry Node.js](elastic-otel-node://release-notes/index.md) | 0.1.0 and later |
196+
| [Elastic Distribution of OpenTelemetry Python](elastic-otel-python://release-notes/index.md) | 0.1.0 and later |
197+
| [Elastic Distribution of OpenTelemetry PHP](elastic-otel-php://release-notes/index.md) | 0.1.0 and later |
198+
| [Elastic APM .NET Agent](apm-agent-dotnet://release-notes/index.md) | 1.0.0 and later |
199+
| [Elastic APM Go Agent](apm-agent-go://release-notes/index.md) | 2.0.0 and later |
200+
| [Elastic APM Java Agent](apm-agent-java://release-notes/index.md) | 1.0.0 and later |
201+
| [Elastic APM Node.js Agent](apm-agent-nodejs://release-notes/index.md) | 4.0.0 and later |
202+
| [Elastic APM PHP Agent](apm-agent-php://release-notes/index.md) | 1.0.0 and later |
203+
| [Elastic APM Python Agent](apm-agent-python://release-notes/index.md) | 6.0.0 and later |
204+
| [Elastic APM Ruby Agent](apm-agent-ruby://release-notes/index.md) | 4.0.0 and later |
205+
| [Elastic APM Real User Monitoring JavaScript Agent](apm-agent-rum-js://release-notes/index.md) | 5.0.0 and later |
206+
| [Elastic APM AWS Lambda extension](apm-aws-lambda://release-notes/release-notes.md) | 1.0.0 and later |
207+
| [Elastic APM Attacher for Kubernetes](apm-k8s-attacher://reference/index.md) | 1.1.3 |
208+
209+
210+
211+
212+
169213

170214

171215

0 commit comments

Comments
 (0)