-
Notifications
You must be signed in to change notification settings - Fork 4
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 #127
[docs] Prepare docs #127
Conversation
👋 @elastic/apm-agent-net 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! |
Hey @colleenmcginnis thanks for getting our docs in shape. I addressed several questions but its hard to parse whats a question to us vs whats a structural comment that describes the paragraph. Let me know if I missed any! It would be good to get this in soonish so that we can do another pass over the content as part of #126. |
Thanks @Mpdreamz.
Sorry for the confusion! |
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.
@Mpdreamz one more question for now!
@colleenmcginnis let me know when you need us to do the final review for that 2nd last checkmark 😸 |
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. |
@Mpdreamz I split the naming changes into two commits: |
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.
@colleenmcginnis almost LGTM 😸 added a few spacing nitpicks.
Oh gosh this might have been my local whitespace settings. 🙈 |
Co-authored-by: Martijn Laarman <[email protected]>
Closes elastic/observability-docs#4056
Closes https://github.com/elastic/obs-docs-team/issues/240
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