Skip to content
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] Migrate docs from AsciiDoc to Markdown #2451

Open
wants to merge 8 commits into
base: main
Choose a base branch
from

Conversation

colleenmcginnis
Copy link
Contributor

Migrate docs from AsciiDoc to Markdown. The preview can be built after #2450 is merged.

@colleenmcginnis colleenmcginnis added the DOCS Any issue related to ECS documentation label Feb 25, 2025
Copy link

Documentation changes preview: https://ecs_bk_2451.docs-preview.app.elstc.co/diff

@mjwolf
Copy link
Contributor

mjwolf commented Mar 4, 2025

@colleenmcginnis There were some changes made to ECS after the docs freeze. Are the new docs generated from the latest main branch? Most of the changes are to the schema files, so I think docs should get the latest changes from automatic generation.

One other thing I saw is docs/release-notes/8.17.asciidoc is not deleted in this PR. It was added to main recently, so it should be deleted with the other asciidoc files.

@colleenmcginnis
Copy link
Contributor Author

Are the new docs generated from the latest main branch?

No. They were generated at the start of the docs freeze.

Most of the changes are to the schema files, so I think docs should get the latest changes from automatic generation.

Is the automatic generation still creating AsciiDoc files? If so, they will need to be updated to Markdown.

@colleenmcginnis
Copy link
Contributor Author

colleenmcginnis commented Mar 4, 2025

Most of the changes are to the schema files, so I think docs should get the latest changes from automatic generation.

Is the automatic generation still creating AsciiDoc files? If so, they will need to be updated to Markdown.

I resolved the merge conflicts. Do these look like the only updates that would have been made? 5cb6754?file-filters%5B%5D=.md&show-deleted-files=true&show-viewed-files=true

@colleenmcginnis
Copy link
Contributor Author

@mdbirnstiehl this should fix the inbound link validation error: elastic/apm-agent-dotnet#2563

@colleenmcginnis colleenmcginnis marked this pull request as ready for review March 4, 2025 21:46
@colleenmcginnis colleenmcginnis requested a review from a team as a code owner March 4, 2025 21:46
@colleenmcginnis colleenmcginnis requested a review from mjwolf March 5, 2025 15:34
@mdbirnstiehl
Copy link
Contributor

@mjwolf Could you help us out here on the test failing. Also, do you know if there were any additional changes made other than the ones mentioned by @colleenmcginnis?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
DOCS Any issue related to ECS documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants