You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/reference/query-languages/esql/README.md
+83-4Lines changed: 83 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -105,16 +105,95 @@ To help differentiate between the static and generated content, the generated co
105
105
% This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../README.md for how to regenerate it.
106
106
```
107
107
108
+
## Version differentiation in Docs V3
109
+
110
+
> [!IMPORTANT]
111
+
> Starting with 9.0, we no longer publish separate documentation branches for every minor release (`9.0`, `9.1`, `9.2`, etc.).
112
+
> This means there won't be a different page for `9.1`, `9.2`, and so on. Instead, all changes landing in subsequent minor releases **will appear on the same page**.
113
+
114
+
Because we now publish just one docs set off of the `main` branch, we use the [`applies_to` metadata](https://elastic.github.io/docs-builder/syntax/applies/) to differentiate features and their availability across different versions. This is a [cumulative approach](https://elastic.github.io/docs-builder/contribute/#cumulative-docs): instead of creating separate pages for each product and release, we update a **single page** with product- and version-specific details over time.
115
+
116
+
`applies_to` allows us to clearly communicate when features are introduced, when they transition from preview to GA, and which versions support specific functionality.
117
+
118
+
This metadata accepts a lifecycle and an optional version.
119
+
120
+
### Functions and operators
121
+
122
+
Use the `@FunctionAppliesTo` annotation within the `@FunctionInfo` annotation on function and operator classes to specify the lifecycle and version for functions and operators.
123
+
124
+
For example, to indicate that a function is in technical preview and applies to version 9.0.0, you would use:
When a feature evolves from preview in `9.0` to GA in `9.2`, add a new entry alongside the existing preview entry and remove the `preview = true` boolean:
137
+
138
+
```java
139
+
@FunctionInfo(
140
+
returnType="boolean",
141
+
preview=false, // the preview boolean can be removed (or flipped to false) when the function becomes GA
We updated [`DocsV3Support.java`](https://github.com/elastic/elasticsearch/blob/main/x-pack/plugin/esql/src/test/java/org/elasticsearch/xpack/esql/expression/function/DocsV3Support.java) to generate the `applies_to` metadata correctly for functions and operators.
151
+
152
+
### Inline `applies_to` metadata
153
+
154
+
Use [inline annotations](https://elastic.github.io/docs-builder/syntax/applies/#inline-annotations) to specify `applies_to` metadata in descriptions, parameter lists, etc.
155
+
156
+
For example, the second item in this list is in technical preview as of version 9.2:
157
+
158
+
```markdown
159
+
- Item 1
160
+
- Item 2 {applies_to}`stack: preview 9.2.`
161
+
```
162
+
163
+
### Key rules
164
+
165
+
1.**Use the `preview = true` boolean** for any tech preview feature - this is required for the Kibana inline docs
166
+
-**Remove `preview = true`** only when the feature becomes GA on serverless and is _definitely_ going GA in the next minor release
167
+
2.**Never delete `appliesTo` entries** - only add new ones as features evolve from preview to GA
168
+
3.**Use specific versions** (`9.0.0`, `9.1.0`) when known, or just `PREVIEW` without a version if timing is uncertain
169
+
4.**Add `applies_to` to examples** where necessary
170
+
171
+
> [!IMPORTANT]
172
+
> We don't use `applies_to` in the legacy asciidoc system for 8.x and earlier versions.
173
+
174
+
### Supported lifecycles
175
+
176
+
-`PREVIEW` - Feature is in technical preview
177
+
-`GA` - Feature is generally available
178
+
-`DEPRECATED` - Feature is deprecated and will be removed in a future release
179
+
-`UNAVAILABLE` - Feature is not available in the current version, but may be available in future releases
180
+
181
+
> [!NOTE]
182
+
> Unreleased version information is automatically sanitized in the docs build output. For example, say you specify `preview 9.3.0`:
183
+
> - Before `9.3.0` is released, the live documentation will display "Planned for a future release" instead of the specific version number.
184
+
> - This will be updated automatically when the version is released.
185
+
108
186
## Tutorials
109
187
110
188
### Adding a new command
111
189
112
190
When adding a new command, for example adding the `CHANGE_POINT` command, do the following:
113
191
1. Create a new file in the `_snippets/commands/layout` directory with the name of the command, for example `change_point.md`.
114
-
2. Add the content for the command to the file. See other files in this directory for examples.
115
-
3. Add the command to the list in `_snippets/lists/processing-commands.md`.
116
-
4. Add an include directive to the `commands/processing-commands.md` file to include the new command.
117
-
5. Add tested examples to the `_snippets/commands/examples` directory. See below for details.
192
+
2. Ensure to specify what versions the command applies to. See [Version differentiation in Docs V3](#version-differentiation-in-docs-v3) for details. [Example PR](https://github.com/elastic/elasticsearch/pull/130314/files#diff-0ab90b6202c5d9eeea75dc95a7cb71dc4d720230342718bff887816771a5a803R3-R6).
193
+
3. Add the content for the command to the file. See other files in this directory for examples.
194
+
4. Add the command to the list in `_snippets/lists/processing-commands.md`.
195
+
5. Add an include directive to the `commands/processing-commands.md` file to include the new command.
196
+
6. Add tested examples to the `_snippets/commands/examples` directory. See below for details.
0 commit comments