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] Prepare docs #127

Merged
merged 16 commits into from
Aug 19, 2024
Merged

[docs] Prepare docs #127

merged 16 commits into from
Aug 19, 2024

Conversation

colleenmcginnis
Copy link
Contributor

@colleenmcginnis colleenmcginnis commented Jul 12, 2024

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

  • @colleenmcginnis convert back to AsciiDoc
  • @colleenmcginnis add initial outline with questions for the dev team in code comments
  • @colleenmcginnis continue clean up / aligning across languages
  • @elastic/apm-agent-net review content that's already there, add content that's missing (especially where there are questions in code comments)
    • Feel free to either commit directly to this PR or add suggestions in PR comments — whichever works best for you!
  • @colleenmcginnis clean up content
  • @elastic/obs-docs peer review
  • @colleenmcginnis address feedback
  • 🆕 @colleenmcginnis convert to Markdown
  • 🆕 @colleenmcginnis reorganize content as needed to be consumed on GitHub
  • 🆕 @colleenmcginnis slight content reframing
  • 🆕 @colleenmcginnis update product naming as needed
  • @elastic/apm-agent-net final review, approve
  • @colleenmcginnis merge

@colleenmcginnis colleenmcginnis requested a review from a team July 16, 2024 14:53
@colleenmcginnis
Copy link
Contributor Author

👋 @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!

docs/configure.asciidoc Outdated Show resolved Hide resolved
docs/configure.asciidoc Outdated Show resolved Hide resolved
docs/configure.asciidoc Outdated Show resolved Hide resolved
docs/configure.asciidoc Outdated Show resolved Hide resolved
docs/get-started.asciidoc Outdated Show resolved Hide resolved
docs/get-started.asciidoc Outdated Show resolved Hide resolved
docs/get-started.asciidoc Outdated Show resolved Hide resolved
docs/get-started.asciidoc Outdated Show resolved Hide resolved
docs/get-started.asciidoc Outdated Show resolved Hide resolved
@Mpdreamz
Copy link
Member

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.

@colleenmcginnis
Copy link
Contributor Author

Thanks @Mpdreamz.

I addressed several questions but its hard to parse whats a question to us vs whats a structural comment that describes the paragraph.

Sorry for the confusion!

Copy link
Contributor Author

@colleenmcginnis colleenmcginnis left a 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!

docs/configure.asciidoc Outdated Show resolved Hide resolved
docs/intro.asciidoc Outdated Show resolved Hide resolved
docs/get-started.asciidoc Outdated Show resolved Hide resolved
docs/get-started.asciidoc Outdated Show resolved Hide resolved
docs/configure.asciidoc Outdated Show resolved Hide resolved
docs/configure.asciidoc Outdated Show resolved Hide resolved
docs/get-started.asciidoc Outdated Show resolved Hide resolved
@Mpdreamz
Copy link
Member

@colleenmcginnis let me know when you need us to do the final review for that 2nd last checkmark 😸

@colleenmcginnis
Copy link
Contributor Author

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.

@colleenmcginnis colleenmcginnis added documentation Improvements or additions to documentation blocked labels Aug 8, 2024
@colleenmcginnis
Copy link
Contributor Author

@Mpdreamz I split the naming changes into two commits: update naming (docs files) and update naming (non-docs files) so we can easily revert if you want to handle non-docs files separately.

@colleenmcginnis colleenmcginnis marked this pull request as ready for review August 15, 2024 14:33
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.

@colleenmcginnis almost LGTM 😸 added a few spacing nitpicks.

docs/configure.md Outdated Show resolved Hide resolved
docs/configure.md Outdated Show resolved Hide resolved
docs/get-started.md Show resolved Hide resolved
docs/get-started.md Outdated Show resolved Hide resolved
docs/get-started.md Outdated Show resolved Hide resolved
docs/get-started.md Outdated Show resolved Hide resolved
docs/get-started.md Outdated Show resolved Hide resolved
docs/get-started.md Outdated Show resolved Hide resolved
@colleenmcginnis
Copy link
Contributor Author

colleenmcginnis commented Aug 15, 2024

added a few spacing nitpicks.

Oh gosh this might have been my local whitespace settings. 🙈

@colleenmcginnis colleenmcginnis merged commit 8d8d3ba into elastic:main Aug 19, 2024
5 checks passed
@colleenmcginnis colleenmcginnis deleted the prep-docs branch August 19, 2024 14:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
blocked documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Move to Markdown: .NET
3 participants