-
Notifications
You must be signed in to change notification settings - Fork 100
[docs] Add Markdown release notes #5374
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.
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
[docs] Add Markdown release notes #5374
Conversation
🎉 Snyk checks have passed. No issues have been found so far.✅ security/snyk check is complete. No issues have been found. (View Details) ✅ license/snyk check is complete. No issues have been found. (View Details) |
|
This pull request does not have a backport label. Could you fix it @colleenmcginnis? 🙏
|
🔍 Preview links for changed docs |
|
This pull request is now in conflicts. Could you fix it @colleenmcginnis? 🙏 |
|
…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.
* copy over changelog yaml files * render release notes, make them publishable (cherry picked from commit b73980b) # Conflicts: # docs/docset.yml # docs/release-notes/index.md # docs/release-notes/toc.yml
* copy over changelog yaml files * render release notes, make them publishable (cherry picked from commit b73980b) # Conflicts: # docs/docset.yml # docs/release-notes/index.md # docs/release-notes/toc.yml
* [docs] Add Markdown release notes (#5374) * copy over changelog yaml files * render release notes, make them publishable (cherry picked from commit b73980b) # Conflicts: # docs/docset.yml # docs/release-notes/index.md # docs/release-notes/toc.yml * remove references to 9.1.x --------- Co-authored-by: Colleen McGinnis <colleen.mcginnis@elastic.co>
* copy over changelog yaml files * render release notes, make them publishable (cherry picked from commit b73980b) # Conflicts: # docs/docset.yml # docs/release-notes/index.md # docs/release-notes/toc.yml Co-authored-by: Colleen McGinnis <colleen.mcginnis@elastic.co>





🍷 Pairs with elastic/elastic-agent-changelog-tool#213 elastic/elastic-agent#9440
What is the problem this PR solves?
Currently the Elastic Agent Control Plane 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 Elastic Agent release notes. This is time consuming for the docs team and often leads to delays in publishing release notes.
How does this PR solve the problem?
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 fleet-server output when generating the release notes using thecolleenmcginnis:markdownbranch ofelastic-agent-changelog-tool.This PR adds generated Markdown Fleet Server release notes here instead in the docs-content repo.
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.
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.
Design Checklist
This is a docs-only change.
Checklist
This is a docs-only change.
Related issues
cc @ebeahan @pierrehilbert @bmorelli25