Skip to content

Conversation

colleenmcginnis
Copy link
Contributor

@colleenmcginnis colleenmcginnis commented Sep 26, 2025

What does this PR do?

Refines the Markdown release notes structure to be compatible with elastic/elastic-agent-changelog-tool#220.

Why is it important?

These updates will (1) eliminate any manual steps in the resulting elastic-agent release notes PR outside of copy edits, and (2) reduce the chance of conflicts when forward porting to later minors and main (like we ran into in #10032 and #10031).

Disruptive User Impact

The resulting rendered pages will not change.

How to test this PR locally

There will be a docs preview.

Related issues

elastic/elastic-agent-changelog-tool#220

cc @karenzone

@colleenmcginnis colleenmcginnis self-assigned this Sep 26, 2025
@colleenmcginnis colleenmcginnis added documentation Improvements or additions to documentation Team:Docs Label for the Observability docs team docs skip-changelog backport-active-9 Automated backport with mergify to all the active 9.[0-9]+ branches labels Sep 26, 2025
@colleenmcginnis colleenmcginnis marked this pull request as ready for review September 29, 2025 16:40
@colleenmcginnis colleenmcginnis requested a review from a team as a code owner September 29, 2025 16:40
@elasticmachine
Copy link
Collaborator

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

Copy link
Contributor

@karenzone karenzone left a comment

Choose a reason for hiding this comment

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

LGTM

@colleenmcginnis colleenmcginnis merged commit 9b565cd into elastic:main Oct 1, 2025
23 checks passed
@colleenmcginnis colleenmcginnis deleted the refine-markdown-rn-structure branch October 1, 2025 17:32
Copy link
Contributor

github-actions bot commented Oct 1, 2025

@Mergifyio backport 9.0 9.1 9.2

Copy link
Contributor

mergify bot commented Oct 1, 2025

backport 9.0 9.1 9.2

✅ Backports have been created

mergify bot pushed a commit that referenced this pull request Oct 1, 2025
* break out minor versions

* rename breaking.md to breaking-changes.md

(cherry picked from commit 9b565cd)

# Conflicts:
#	docs/release-notes/_snippets/9.1.0/breaking-changes.md
#	docs/release-notes/_snippets/9.1.1/breaking-changes.md
#	docs/release-notes/_snippets/9.1.2/breaking-changes.md
#	docs/release-notes/_snippets/9.1.3/breaking-changes.md
#	docs/release-notes/_snippets/9.1.4/breaking-changes.md
#	docs/release-notes/_snippets/breaking-changes.md
#	docs/release-notes/_snippets/deprecations.md
#	docs/release-notes/_snippets/index.md
mergify bot pushed a commit that referenced this pull request Oct 1, 2025
* break out minor versions

* rename breaking.md to breaking-changes.md

(cherry picked from commit 9b565cd)
mergify bot pushed a commit that referenced this pull request Oct 1, 2025
* break out minor versions

* rename breaking.md to breaking-changes.md

(cherry picked from commit 9b565cd)
colleenmcginnis added a commit that referenced this pull request Oct 1, 2025
* break out minor versions

* rename breaking.md to breaking-changes.md

(cherry picked from commit 9b565cd)

Co-authored-by: Colleen McGinnis <[email protected]>
colleenmcginnis added a commit that referenced this pull request Oct 1, 2025
* break out minor versions

* rename breaking.md to breaking-changes.md

(cherry picked from commit 9b565cd)

Co-authored-by: Colleen McGinnis <[email protected]>
colleenmcginnis added a commit that referenced this pull request Oct 1, 2025
#10245)

* [docs] Refine Markdown release notes structure (#10184)

* break out minor versions

* rename breaking.md to breaking-changes.md

(cherry picked from commit 9b565cd)

# Conflicts:
#	docs/release-notes/_snippets/9.1.0/breaking-changes.md
#	docs/release-notes/_snippets/9.1.1/breaking-changes.md
#	docs/release-notes/_snippets/9.1.2/breaking-changes.md
#	docs/release-notes/_snippets/9.1.3/breaking-changes.md
#	docs/release-notes/_snippets/9.1.4/breaking-changes.md
#	docs/release-notes/_snippets/breaking-changes.md
#	docs/release-notes/_snippets/deprecations.md
#	docs/release-notes/_snippets/index.md

* fix conflicts

---------

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

Labels

backport-active-9 Automated backport with mergify to all the active 9.[0-9]+ branches docs documentation Improvements or additions to documentation skip-changelog Team:Docs Label for the Observability docs team

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants