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 #2221

Open
wants to merge 10 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 #2220 is merged.

@colleenmcginnis colleenmcginnis added the Team:Docs Label for the Observability docs team label Feb 26, 2025
@xrmx
Copy link
Member

xrmx commented Mar 3, 2025

run docs-build

@colleenmcginnis
Copy link
Contributor Author

@xrmx can you please review when you have a chance (preview)?

Copy link
Member

@xrmx xrmx left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I haven't gone through all but there a few things broken


The precedence is as follows:

* [Central configuration](#config-central_config) (supported options are marked with [![dynamic config](../images/dynamic-config.svg "") ](#dynamic-configuration))
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Rendering of this badge looks off, not a blocker ofc

Schermata del 2025-03-04 16-59-39

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a known issue: elastic/docs-builder#601


## Step 1: Select the AWS Region and Architecture [_step_1_select_the_aws_region_and_architecture]

<style>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Rendering of this is broken

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll take a closer look at this today.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

elastic/docs-builder does not support CSS and JavaScript in Markdown, and there is no plan to support it in the future. I made some updates in e795df5. Take a look at the preview and let me know what you think about this approach.

@@ -0,0 +1,5 @@
toc:
- file: index.md
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Something is wrong with rendering

Schermata del 2025-03-04 17-11-02

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is expected for now. It will be resolved when we're able to bundle pages from all repos together. elastic/docs-builder#621

- file: performance-tuning.md
- file: upgrading.md
children:
- file: upgrading-6.x.md
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Links to these do not work in preview, the js call gets a 403

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a known issue: elastic/docs-builder#625

Co-authored-by: Riccardo Magliocchetti <riccardo.magliocchetti@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
agent-python Team:Docs Label for the Observability docs team
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants