Update OTLP docs to use consistent applies_to tags#5362
Update OTLP docs to use consistent applies_to tags#5362alexandra5000 wants to merge 4 commits intoelastic:mainfrom
applies_to tags#5362Conversation
✅ Vale Linting ResultsNo issues found on modified lines! The Vale linter checks documentation changes against the Elastic Docs style guide. To use Vale locally or report issues, refer to Elastic style guide for Vale. |
🔍 Preview links for changed docs |
| applies_to: | ||
| stack: preview 9.2 | ||
| deployment: | ||
| self: | ||
| self: preview 9.2 |
There was a problem hiding this comment.
this should not have both of these labels.
Is this deployment strictly for vanilla self-managed environments, or is it for ECE/ECK too?
if it is for all 3, the deployments can be listed in the front matter, and the stack version should be listed as a prerequisite.
if it is just for vanilla self-managed (NOT ECE/ECK), it can be done like this:
applies_to:
deployment:
self: preview 9.2
self-managed =/= all non-Elastic Cloud offerings
There was a problem hiding this comment.
Thanks @shainaraskas! The OTLP endpoint applies to self-managed, ECE, and ECK (as in the overview), so I’ve updated the front matter - hope it's ok now.
| deployment: | ||
| self: | ||
| self: preview 9.2 | ||
| ece: preview 9.2 | ||
| eck: preview 9.2 |
There was a problem hiding this comment.
ECE and ECK are independent products that use a different versioning scheme. e.g. ECE is currently on 4.x and ECK is on 3.x.
Both of these platforms allow you to deploy elasticsearch on them. however, this means that we need to communicate that:
- These instructions are valid for these 3 deployment types (fyi, 9.2 can be deployed on multiple ECE/ECK versions)
- There is a restriction on the stack version that can use the endpoint, regardless of deployment type.
In this case, you can do one of the following (both have their downsides)
label by deployment type (recommend)
applies_to:
deployment:
self:
ece:
eck:
with a Prerequisites \ Requirements \ Compatibility section that states the required stack version is 9.2 (and likely a note block indicating the feature is in preview)
focus on communicating the lifecycle status
applies_to:
stack: preview 9.2
and your prerequisites would then list your deployment types.
how I came to this conclusion
This all (roughly) follows our dimensions guidance:
https://www.elastic.co/docs/contribute-docs/how-to/cumulative-docs/guidelines#dimensions
https://www.elastic.co/docs/contribute-docs/how-to/cumulative-docs/example-scenarios#primary-dimension
There was a problem hiding this comment.
Thanks for the clarification. I’ve applied the recommended approach:
- Page-level
applies_tonow uses only the Deployment dimension (deployment: self,ece,eck). - I added a "Prerequisites" section, which states the required Elastic Stack version (9.2+) and that 9.2 can run on multiple ECE/ECK versions.
This keeps deployment type as the primary dimension and documents the stack version and preview status on the page itself rather than in the frontmatter.
shainaraskas
left a comment
There was a problem hiding this comment.
we can be a tiny bit more precise. provided a suggestion. dimension concerns all resolved :)
|
|
||
| ## Prerequisites | ||
|
|
||
| You need {{stack}} 9.2 or later (the OTLP endpoint is available on ECE, ECK, and self-managed deployments that run this stack version). |
There was a problem hiding this comment.
is the dependency specific on the elasticsearch version? people use the entire stack of the same version but we can specify if we know
| You need {{stack}} 9.2 or later (the OTLP endpoint is available on ECE, ECK, and self-managed deployments that run this stack version). | |
| An {{es}} cluster running {{stack}} 9.2 or later. The OTLP endpoint is available on ECE, ECK, and self-managed deployments that run this stack version. |
Summary
Mark OTLP/HTTP endpoint doc: self-managed as preview 9.2
In
tsds-ingest-otlp.md, setdeployment.selftopreview 9.2in the frontmatter so self-managed is clearly documented as preview, consistent with the stack.Closes #5136
Generative AI disclosure
To help us ensure compliance with the Elastic open source and documentation guidelines, please answer the following: