-
Notifications
You must be signed in to change notification settings - Fork 532
[docs] Migrate docs from AsciiDoc to Markdown #16082
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
This pull request does not have a backport label. Could you fix it @colleenmcginnis? 🙏
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Q about the workflow. Are the docs build per-branch, like how we did in the past?
e.g. if we have a change that goes into 9.0.100 which is a version released later than 9.1.0. Should we add the changelog directly to main under section 9.0.100? Does it matter if we backport the changelog?
|
||
Review the deprecated functionality for your Elastic APM version. While deprecations have no immediate impact, we strongly encourage you update your implementation after you upgrade. | ||
|
||
% To learn how to upgrade, check out <uprade docs>. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
% To learn how to upgrade, check out <uprade docs>. | |
% To learn how to upgrade, check out <upgrade docs>. |
I see this typo in docs-content as well. Not sure if it is widespread
cc 9.0 release manager @inge4pres |
|
||
**Release date:** March 25, 2025 | ||
|
||
::::{dropdown} Change server information endpoint "/" to only accept GET and HEAD requests |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
thanks for bringing this in from elastic/docs-content#647 already!
@KOTungseth can you advise? Should they be adding to a |
Here are some clarifications:
Let me know if you have additional questions! |
This is ready for review! You can view the preview by clicking the "View deployment" button: ![]() If you're interested in building a preview locally, you can follow the instructions here: https://elastic.github.io/docs-builder/contribute/locally/. Note: The release notes section at the bottom of the table of contents looks strange, but that's expected at this stage (see elastic/docs-builder#621). Let me know if you have any more questions after you take a look! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
lgtm, thanks!
@carsonip we also need to update our release automations to account for these changes? Have we discussed this? |
Nice catch. It was not discussed, and there are still a lot of release automation on asciidoc. https://github.com/elastic/apm-server/blob/main/release.mk . I've created #16181 for it. |
Migrate docs from AsciiDoc to Markdown. The preview can be built after #16081 is merged.
Notes:
main
so any changes to the 8.x changelog files should target the8.x
and specific version branches instead (for example,8.18
). Let me know if you anticipate any problems with this approach.HEAD
changelog file, the AsciiDoc9.0
changelog, and the Markdown release note related files from docs-content (release notes, known issues, breaking changes, deprecations). @KOTungseth I did my best to follow the format introduced by the template text at the top of each file (except for individual known issue sections since I wasn't sure if we should keep the 8.x known issues onmain
).main
(at least in the short term). @KOTungseth can correct me if I'm wrong!CHANGELOG.md
file in the top level of this repo to help users find release notes from the GitHub repo, but we don't need it if you don't think it's necessary.