Skip to content

[docs] Add Markdown release notes #9440

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 22 commits into from
Sep 10, 2025
Merged

[docs] Add Markdown release notes #9440

merged 22 commits into from
Sep 10, 2025

Conversation

colleenmcginnis
Copy link
Contributor

@colleenmcginnis colleenmcginnis commented Aug 18, 2025 •
edited
Loading

🍷 Pairs with elastic/elastic-agent-changelog-tool#213

What does this PR do?

Adds generated Markdown Elastic Agent release notes here instead in the docs-content repo.

Why is it important?

Currently the Elastic Agent team generates release notes in AsciiDoc in this repo and the @elastic/ingest-docs team has to manually translate AsciiDoc to Markdown, copy to another repo (docs-content), split into multiple files, and integrate with Fleet Server release notes. This is time consuming for the docs team and often leads to delays in publishing release notes.

In elastic/elastic-agent-changelog-tool#213, I updated the automation to allow generating Markdown, formatting it, and putting it into the correct files directly using elastic-agent-changelog-tool. This is the elastic-agent output when generating the release notes using the colleenmcginnis:markdown branch of elastic-agent-changelog-tool.

Checklist

  • I have read and understood the pull request guidelines of this project.
  • My code follows the style guidelines of this project
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have made corresponding change to the default configuration files
  • I have added tests that prove my fix is effective or that my feature works
  • I have added an entry in ./changelog/fragments using the changelog tool
  • I have added an integration test or an E2E test

Disruptive User Impact

This approach to release notes would mean splitting the source files for Fleet Server and Elastic Agent release notes, but they would still live next to each other on the docs site.

Screenshot 2025-08-18 at 11 00 53 AM

How to test this PR locally

This repo is not currently hooked up to the docs build system so we don't have a PR preview yet, but you can build the docs locally.

Screenshot 2025-08-18 at 10 53 56 AM

Note: Right now it will build independently from the rest of the Release notes, but once this repo is hooked up to the docs build system, these release notes will be integrated into the larger Release notes table of contents.

Related issues

Questions to ask yourself

  • How are we going to support this in production?
  • How are we going to measure its adoption?
  • How are we going to debug this?
  • What are the metrics I should take care of?
  • ...

cc @ebeahan @pierrehilbert @bmorelli25

@colleenmcginnis colleenmcginnis self-assigned this Aug 18, 2025
@colleenmcginnis colleenmcginnis added Team:Docs Label for the Observability docs team docs labels Aug 18, 2025
@mergify Mergify
Copy link
Contributor

mergify bot commented Aug 18, 2025

This pull request does not have a backport label. Could you fix it @colleenmcginnis? 🙏
To fixup this pull request, you need to add the backport labels for the needed
branches, such as:

  • backport-./d./d is the label that automatically backports to the 8./d branch. /d is the digit
  • backport-active-all is the label that automatically backports to all active branches.
  • backport-active-8 is the label that automatically backports to all active minor branches for the 8 major.
  • backport-active-9 is the label that automatically backports to all active minor branches for the 9 major.

@colleenmcginnis colleenmcginnis mentioned this pull request Aug 20, 2025
Merged
@colleenmcginnis colleenmcginnis changed the title [docs] [proof of concept] Add Markdown release notes [docs] Add Markdown release notes Aug 20, 2025
This was referenced Aug 29, 2025
Merged
Merged
@colleenmcginnis colleenmcginnis mentioned this pull request Sep 4, 2025
Merged
@mergify Mergify
Copy link
Contributor

mergify bot commented Sep 4, 2025

This pull request is now in conflicts. Could you fix it? 🙏
To fixup this pull request, you can check out it locally. See documentation: https://help.github.com/articles/checking-out-pull-requests-locally/

git fetch upstream
git checkout -b add-markdown-release-notes upstream/add-markdown-release-notes
git merge upstream/main
git push upstream add-markdown-release-notes

This was referenced Sep 4, 2025
Merged
Merged
@elastic-sonarqube Elastic SonarQube
Copy link

Quality Gate passed Quality Gate passed

Issues
0 New issues
0 Fixed issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarQube

@elasticmachine
Copy link
Collaborator

💚 Build Succeeded

History

cc @colleenmcginnis

@colleenmcginnis colleenmcginnis mentioned this pull request Sep 10, 2025
Merged
@colleenmcginnis colleenmcginnis merged commit 86fd0df into elastic:main Sep 10, 2025
14 checks passed
@colleenmcginnis colleenmcginnis deleted the add-markdown-release-notes branch September 10, 2025 19:10
colleenmcginnis added a commit to elastic/docs-content that referenced this pull request Sep 11, 2025
@colleenmcginnis
[do not merge!] Removes the combined Fleet Server and Elastic Agent r…
c2f9866 
…elease notes (#2818)

Related to elastic/docs-projects#488
elastic/elastic-agent-changelog-tool#213,
elastic/elastic-agent#9440,
elastic/fleet-server#5374

⚠️ **DO NOT MERGE BEFORE
elastic/docs-builder#1830 IS BOTH MERGED AND
INCLUDED IN A NEW RELEASE** ⚠️

Removes the combined Fleet Server and Elastic Agent release notes in
favor of separate release notes in the fleet-server and elastic-agent
repos. This enables the dev team to own the release notes process.
This was referenced Sep 16, 2025
Merged
Merged
Merged
Merged
@karenzone karenzone added backport-9.0 Automated backport to the 9.0 branch backport-9.1 Automated backport to the 9.1 branch labels Sep 16, 2025
mergify bot pushed a commit that referenced this pull request Sep 16, 2025
@colleenmcginnis @mergify
[docs] Add Markdown release notes (#9440)
b96ea79 
* add config.changelog.yaml

* add changelog yml files

* check 9.1.2 output

* check 9.1.1 output

* check 9.1.0 output

* update 9.1.0.yaml

* check 9.0.5 output

* check 9.0.4 output

* check 9.0.3 output

* check 9.0.2 output

* check 9.0.1 output

* check 9.0.0 output

* clean up yaml files

* remaining formatting fixes

* add build out docs-builder content

* fix build errors

* add links to other pages

* add 9.0.6 release notes

* add 9.1.3 release notes

(cherry picked from commit 86fd0df)

# Conflicts:
#	changelog/9.0.1.yaml
#	changelog/9.0.2.yaml
#	changelog/9.0.3.yaml
#	changelog/9.0.6.yaml
#	docs/docset.yml
#	docs/release-notes/index.md
#	docs/release-notes/toc.yml
@mergify mergify bot mentioned this pull request Sep 16, 2025
Merged
8 tasks
mergify bot pushed a commit that referenced this pull request Sep 16, 2025
@colleenmcginnis @mergify
[docs] Add Markdown release notes (#9440)
92afbad 
* add config.changelog.yaml

* add changelog yml files

* check 9.1.2 output

* check 9.1.1 output

* check 9.1.0 output

* update 9.1.0.yaml

* check 9.0.5 output

* check 9.0.4 output

* check 9.0.3 output

* check 9.0.2 output

* check 9.0.1 output

* check 9.0.0 output

* clean up yaml files

* remaining formatting fixes

* add build out docs-builder content

* fix build errors

* add links to other pages

* add 9.0.6 release notes

* add 9.1.3 release notes

(cherry picked from commit 86fd0df)

# Conflicts:
#	changelog/9.1.0.yaml
#	changelog/9.1.3.yaml
#	docs/docset.yml
#	docs/release-notes/index.md
#	docs/release-notes/toc.yml
This was referenced Sep 16, 2025
Merged
Merged
Merged
colleenmcginnis added a commit that referenced this pull request Sep 16, 2025
@mergify @colleenmcginnis
[9.0](backport #9440) [docs] Add Markdown release notes (#9990)
88fa44f 
* [docs] Add Markdown release notes (#9440)

* add config.changelog.yaml

* add changelog yml files

* check 9.1.2 output

* check 9.1.1 output

* check 9.1.0 output

* update 9.1.0.yaml

* check 9.0.5 output

* check 9.0.4 output

* check 9.0.3 output

* check 9.0.2 output

* check 9.0.1 output

* check 9.0.0 output

* clean up yaml files

* remaining formatting fixes

* add build out docs-builder content

* fix build errors

* add links to other pages

* add 9.0.6 release notes

* add 9.1.3 release notes

(cherry picked from commit 86fd0df)

# Conflicts:
#	changelog/9.0.1.yaml
#	changelog/9.0.2.yaml
#	changelog/9.0.3.yaml
#	changelog/9.0.6.yaml
#	docs/docset.yml
#	docs/release-notes/index.md
#	docs/release-notes/toc.yml

* resolve conflicts

* remove 9.1.x references

---------

Co-authored-by: Colleen McGinnis <[email protected]>
colleenmcginnis added a commit that referenced this pull request Sep 16, 2025
@mergify @colleenmcginnis
[9.1] (backport #9440) [docs] Add Markdown release notes (#9991)
b950f25 
* [docs] Add Markdown release notes (#9440)

* add config.changelog.yaml

* add changelog yml files

* check 9.1.2 output

* check 9.1.1 output

* check 9.1.0 output

* update 9.1.0.yaml

* check 9.0.5 output

* check 9.0.4 output

* check 9.0.3 output

* check 9.0.2 output

* check 9.0.1 output

* check 9.0.0 output

* clean up yaml files

* remaining formatting fixes

* add build out docs-builder content

* fix build errors

* add links to other pages

* add 9.0.6 release notes

* add 9.1.3 release notes

(cherry picked from commit 86fd0df)

# Conflicts:
#	changelog/9.1.0.yaml
#	changelog/9.1.3.yaml
#	docs/docset.yml
#	docs/release-notes/index.md
#	docs/release-notes/toc.yml

* fix conflicts

---------

Co-authored-by: Colleen McGinnis <[email protected]>
intxgo pushed a commit to intxgo/elastic-agent that referenced this pull request Sep 24, 2025
@colleenmcginnis @intxgo
[docs] Add Markdown release notes (elastic#9440)
62a946c 
* add config.changelog.yaml

* add changelog yml files

* check 9.1.2 output

* check 9.1.1 output

* check 9.1.0 output

* update 9.1.0.yaml

* check 9.0.5 output

* check 9.0.4 output

* check 9.0.3 output

* check 9.0.2 output

* check 9.0.1 output

* check 9.0.0 output

* clean up yaml files

* remaining formatting fixes

* add build out docs-builder content

* fix build errors

* add links to other pages

* add 9.0.6 release notes

* add 9.1.3 release notes
@colleenmcginnis colleenmcginnis mentioned this pull request Sep 26, 2025
Merged
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@pierrehilbert pierrehilbert pierrehilbert approved these changes

@pkoutsovasilis pkoutsovasilis Awaiting requested review from pkoutsovasilis pkoutsovasilis is a code owner automatically assigned from elastic/elastic-agent-control-plane

@kaanyalti kaanyalti Awaiting requested review from kaanyalti kaanyalti is a code owner automatically assigned from elastic/elastic-agent-control-plane

@ebeahan ebeahan Awaiting requested review from ebeahan

Assignees

@colleenmcginnis colleenmcginnis

Labels

backport-9.0 Automated backport to the 9.0 branch backport-9.1 Automated backport to the 9.1 branch docs skip-changelog Team:Docs Label for the Observability docs team

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@colleenmcginnis @elasticmachine @pierrehilbert @karenzone