-
Notifications
You must be signed in to change notification settings - Fork 3
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] Prepare docs #287
[docs] Prepare docs #287
Conversation
👋 @elastic/apm-agent-node-js can you please take an initial look here? I left many questions for you in code comments throughout the doc files. As you read through, if you have answers to questions, feel free to either commit directly to this PR or add suggestions in PR comments — whatever works best for you! |
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.
For better or worse, there is a link to the getting-started.mdx doc in the https://www.elastic.co/observability-labs/blog/elastic-opentelemetry-distribution-node-js blog post (see "Please try it out" in the bottom section) that will have to get updated when this is merged.
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.
I added this to the "To do" checklist above.
Thanks for your patience here! I've updated the "To do" list above with some 🆕 items that reflect some recent changes to how we're approaching documenting Elastic Distributions for OpenTelemetry. This includes converting from AsciiDoc to Markdown. Users will be directed to this repo to read the docs on GitHub. We're not going to build and host these docs on elastic.co/guide right now. |
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.
@trentm I left some questions for you below. I know you put a lot of thought into reviewing these changes to the docs already, so I didn't want to make too many more changes (besides translating to Markdown) without your input!
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.
Sorry for the delay in responding, @colleenmcginnis.
@trentm I split the naming changes into two commits: |
@trentm I don't have permission to merge in this repo. Feel free to merge when you're ready. |
Closes elastic/observability-docs#4057
Closes https://github.com/elastic/obs-docs-team/issues/239
Builds out minimal viable docs.
What's included
This includes the overall structure of the initial doc set. There is some missing information. I've left code comments with questions to be answered throughout the files.
Read more about what needs to be included in these docs in Elastic Distributions for OpenTelemetry (Mini docs style guide) (internal doc).
To do