Skip to content

Conversation

szabosteve
Copy link
Contributor

@szabosteve szabosteve commented Jul 22, 2025

Overview

Related to #122062

This PR adds an applies_to tag to the discovery.ec2.protocol setting to indicate that it will be removed in 9.1.

Note

As the markdown-based documentation is cumulative, we need to tag documentation sections to indicate their availability in the 9.x lifecycle. There is no longer a new documentation set published with every minor release; the same page remains valid over time and displays version-related updates. This is why the applies_to tags are used (in the page frontmatter, or inline).

Refer to the following pages for more information:

@elasticsearchmachine elasticsearchmachine added v9.2.0 needs:triage Requires assignment of a team area label labels Jul 22, 2025
@szabosteve szabosteve marked this pull request as draft July 22, 2025 15:28
@szabosteve szabosteve added >docs General docs changes Team:Docs Meta label for docs team labels Jul 22, 2025
Copy link
Contributor

github-actions bot commented Jul 22, 2025

🔍 Preview links for changed docs

@szabosteve szabosteve requested a review from DaveCTurner July 22, 2025 15:36
@DaveCTurner
Copy link
Contributor

Discussed in Slack, but for posterity this renders thusly:

image

After the 9.1.0 release it'll show Removed in 9.1.0.

That's perhaps not quite the right way to document this. This setting doesn't do anything in 9.1.0+ (hence why we didn't want to document it) but it still exists as a setting so it's not an error to set it. It's deprecated, but we will not remove it until 10.0.0.

@szabosteve szabosteve marked this pull request as ready for review July 23, 2025 08:44
@elasticsearchmachine
Copy link
Collaborator

Pinging @elastic/es-docs (Team:Docs)

@elasticsearchmachine elasticsearchmachine removed the needs:triage Requires assignment of a team area label label Jul 23, 2025
@DaveCTurner
Copy link
Contributor

So now it says Deprecation planned and I guess that means it'll eventually say Deprecated in 9.1.0? That's true, but only half the story. Typically when something is deprecated it continues to work (except with a warning) until it's removed, whereas this setting becomes a no-op from 9.1.0 onwards. If we have to document it, we should explain that difference in behaviour in the docs too.

Copy link
Contributor

@DaveCTurner DaveCTurner left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@szabosteve szabosteve added v9.1.0 auto-backport Automatically create backport pull requests when merged labels Jul 23, 2025
@szabosteve szabosteve merged commit 3990ada into elastic:main Jul 23, 2025
10 checks passed
@szabosteve szabosteve deleted the discovery-applies-to branch July 23, 2025 11:39
@elasticsearchmachine
Copy link
Collaborator

💚 Backport successful

Status Branch Result
9.1

szabosteve added a commit to szabosteve/elasticsearch that referenced this pull request Jul 23, 2025
…ic#131702)

* [DOCS] Tags discovery.ec2.protocol as removed in 9.1.

* Adds frontmatter applies_to.

* Changes lifecycle statement to deprecated.

* Addresses feedback.
elasticsearchmachine pushed a commit that referenced this pull request Jul 23, 2025
…) (#131752)

* [DOCS] Tags discovery.ec2.protocol as removed in 9.1.

* Adds frontmatter applies_to.

* Changes lifecycle statement to deprecated.

* Addresses feedback.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

auto-backport Automatically create backport pull requests when merged >docs General docs changes Team:Docs Meta label for docs team v9.1.0 v9.2.0

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants