[docs] Prepare minimal viable docs

[colleenmcginnis]

What does this pull request do?

Builds out minimal viable docs. At a minimum, distribution docs should answer all of the following questions:

• What is the product?
• Why would someone use the product?
  • What problem does it solve?
• How does the product fit into the larger ecosystem?
  • In this case, both the Elastic and OpenTelemetry ecosystems.
• Does the product have any dependencies?
• Where can the user acquire the product?
  • If there are multiple options, provide guidance on how to choose the best approach.
• How does the user install the product?
  • If there are multiple options, provide guidance on how to choose the best approach.
• What are the basic configuration options?
• How does the user set configuration options?
• What does a simple start-to-finish operation look like?
  • Include a description of what the user will see if the operation has completed successfully.

The initial commit includes the overall structure, but there is some information that is missing or needs to be validated. 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 of OpenTelemetry (Mini docs style guide) (internal doc).

To do

• [x] @colleenmcginnis add initial draft with questions for the dev team in code comments
• [x] @elastic/apm-agent-python review initial draft content, respond to questions in code comments
  • Feel free to either commit directly to this PR or add suggestions in PR comments — whichever works best for you!
• [x] @colleenmcginnis address comments, clean up content
• [x] @elastic/apm-agent-python review final draft
• [x] @colleenmcginnis address comments
• [ ] @elastic/apm-agent-python approve and merge

Related issues

Closes https://github.com/elastic/obs-docs-team/issues/241

[colleenmcginnis]

@xrmx I'm not sure if I should make any changes related to these two comments https://github.com/elastic/elastic-otel-python/pull/110#discussion_r1728542618 and https://github.com/elastic/elastic-otel-python/pull/110#discussion_r1730821847 or if we should hold this PR until the next release. Let me know what you would like to do!

[xrmx]

Will merge the PR after a release where the instructions will work. Thanks!

Il gio 29 ago 2024, 19:39 Colleen McGinnis @.***> ha scritto:

@xrmx https://github.com/xrmx I'm not sure if I should make any changes related to these two comments #110 (comment) https://github.com/elastic/elastic-otel-python/pull/110#discussion_r1728542618 and #110 (comment) https://github.com/elastic/elastic-otel-python/pull/110#discussion_r1730821847 or if we should hold this PR until the next release. Let me know what you would like to do!

— Reply to this email directly, view it on GitHub https://github.com/elastic/elastic-otel-python/pull/110#issuecomment-2318470144, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAADFBBIIE65COVABC24ZFTZT5MGNAVCNFSM6AAAAABM6KYQI6VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDGMJYGQ3TAMJUGQ . You are receiving this because you were mentioned.Message ID: @.***>