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: Switch from Asciidoc to MDX #110

Merged
merged 3 commits into from
Jul 3, 2024
Merged

Docs: Switch from Asciidoc to MDX #110

merged 3 commits into from
Jul 3, 2024

Conversation

bmorelli25
Copy link
Member

@bmorelli25 bmorelli25 commented Jun 17, 2024

Summary

This PR converts the existing asciidoc documentation to MDX. .mdx is the file format our new documentation system uses.

My team will help structure and improve content at a later date. This is part one of https://github.com/elastic/obs-docs-team/issues/231.

Preview this PR

We do not currently have a way to generate PR previews for this content (yet).
Here's what the auto-generated config page looks like when I build this PR locally:

Screenshot 2024-06-17 at 10 59 28 AM

Build this PR locally

  1. You can build this PR locally by checking out the following branches:
    1. This PR in elastic/elastic-otel-dotnet ➡️ gh pr checkout 110
    2. This PR in elastic/docs-site ➡️ https://github.com/elastic/docs-site/pull/23
  2. cd into docs-site and run nvm use && yarn && yarn init-docs.
  3. Run docsmobile dev --contentDir=../elastic-otel-dotnet --docNavId=elastic-otel-dotnet --productVersion=main.

Related

@bmorelli25 bmorelli25 marked this pull request as ready for review June 17, 2024 18:00
Copy link
Member

@Mpdreamz Mpdreamz left a comment

Choose a reason for hiding this comment

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

Exciting! Thanks @bmorelli25

@Mpdreamz Mpdreamz merged commit e4dccf0 into main Jul 3, 2024
5 checks passed
@Mpdreamz Mpdreamz deleted the move-docs-to-mdx branch July 3, 2024 08:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants