-
Notifications
You must be signed in to change notification settings - Fork 197
[9.1] (backport #9440) [docs] Add Markdown release notes #9991
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
Conversation
* 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
Cherry-pick of 86fd0df has failed:
To fix up this pull request, you can check it out locally. See documentation: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/checking-out-pull-requests-locally |
Backporting to 9.1 to support our release notes process |
🔍 Preview links for changed docs |
|
💚 Build Succeeded
History
|
🍷 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 thecolleenmcginnis:markdown
branch ofelastic-agent-changelog-tool
.Checklist
./changelog/fragments
using the changelog toolDisruptive 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.
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.
Related issues
Questions to ask yourself
cc @ebeahan @pierrehilbert @bmorelli25
This is an automatic backport of pull request #9440 done by Mergify.