Skip to content

Conversation

charlotte-hoblik
Copy link
Contributor

@charlotte-hoblik charlotte-hoblik commented Aug 14, 2025

This PR adds editorial changes to match release notes guidance

  1. Updates the automated “no changes” messages to follow the latest style guidance:

    • No breaking changes in this versionThere are no breaking changes associated with this release.

    • No deprecations in this versionThere are no deprecations associated with this release.

Updating the “no changes” messages improves clarity and ensures consistency across products.

  1. Changes deprecated coming tag to ga
  2. Adds possibility to manually edit release notes when necessarily

Connected to

https://github.com/elastic/developer-docs-team/issues/334

@charlotte-hoblik charlotte-hoblik self-assigned this Aug 14, 2025
@charlotte-hoblik charlotte-hoblik requested a review from a team as a code owner August 14, 2025 14:33
@charlotte-hoblik charlotte-hoblik added >docs General docs changes Team:Docs Meta label for docs team release_note:enhancement labels Aug 14, 2025
@elasticsearchmachine
Copy link
Collaborator

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

@leemthompo
Copy link
Contributor

@charlotte-hoblik If we go down the road of only publishing the release notes on release day, I think we can probably avoid using applies_to tags altogether in the release notes. Rationale:

  • Release notes are already clearly scoped to a specific version
  • Using a tag like ga 9.2.0 with the generic tooltips we have about feature availability in a section that lists deprecations is probably confusing

This would just require @brianseeders adjusting the RNs tool to no longer require a follow up PR to remove the coming tags. :)

@charlotte-hoblik
Copy link
Contributor Author

Good point @leemthompo I was actually debating this idea myself. I’ll just remove that part from the changes.

@charlotte-hoblik charlotte-hoblik changed the title Update tagging and “no changes” messages in release notes Update “no changes” messages in release notes Aug 14, 2025
@charlotte-hoblik charlotte-hoblik marked this pull request as draft August 14, 2025 15:07
Copy link
Contributor

@leemthompo leemthompo left a comment

Choose a reason for hiding this comment

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

Wording changes LGTM, if Brian is happy to have us remove the coming tag generation here too feel free to re-expand the scope :)

* [docs] Add support for overriding entries in the release notes

* Update changelog bundles with overrides
@charlotte-hoblik charlotte-hoblik marked this pull request as ready for review August 28, 2025 10:10
@elasticsearchmachine
Copy link
Collaborator

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

@charlotte-hoblik
Copy link
Contributor Author

I ended up updating the tag from coming to ga so we can go ahead and merge this. This way, we also stop using the deprecated tag. Once the team finalize their broader plans for the release note process, we can update it accordingly. @shainaraskas

@charlotte-hoblik charlotte-hoblik changed the title Update “no changes” messages in release notes Update Elasticsearch release notes automation Aug 28, 2025
@charlotte-hoblik charlotte-hoblik merged commit 678e4b9 into main Aug 29, 2025
34 checks passed
@charlotte-hoblik charlotte-hoblik deleted the charlotte-releasenote-tagging branch August 29, 2025 07:40
JeremyDahlgren pushed a commit to JeremyDahlgren/elasticsearch that referenced this pull request Aug 29, 2025
* Update breaking changes and deprecations

* update release note tagging

* revert tagging change

* Update tests after template changes

* [docs] Add support for overriding entries in the release notes (elastic#133592)

* [docs] Add support for overriding entries in the release notes

* Update changelog bundles with overrides

* Use ga instead of comming tag

* Update tests after template change

---------

Co-authored-by: Brian Seeders <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

>docs General docs changes release_note:enhancement Team:Docs Meta label for docs team v9.2.0

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants