[docs] Prepare docs #328
[docs] Prepare docs #328
Conversation
|
👋 @elastic/apm-agent-java 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/configuration.asciidoc
Outdated
| //// | ||
| [discrete] | ||
| [[configure-auth-methods]] | ||
| === Authentication methods |
There was a problem hiding this comment.
This section needs to be the same as the content for OTEL_EXPORTER_OTLP_HEADERS in https://www.elastic.co/guide/en/observability/current/apm-open-telemetry-direct.html#apm-instrument-apps-otel
It will be the same for all agents. Maybe it can be a generic doc fragment that gets included in each agent doc?
docs/get-started.asciidoc
Outdated
| //// | ||
| Step-by-step instructions | ||
| //// | ||
|
|
There was a problem hiding this comment.
This will be generic to all agents. Basically open the APM UI and look at the services listed to find your service. We probably have this in a dozen places in the docs, so maybe we should have this centralized somewhere?
docs/get-started.asciidoc
Outdated
| === Next steps | ||
|
|
||
| * <<configuration,Configure the distro>> to send data to Elastic. | ||
| * Learn more about viewing and interpreting data in the {observability-guide}/apm.html[Observability guide]. |
There was a problem hiding this comment.
I wonder if we can link to a more actionable page (or pages). This link kinda drops the user at a useless landing page with generic info.
There was a problem hiding this comment.
I agree. I was thinking of linking to a page related to the APM UI, but we'll need to merge elastic/observability-docs#3723 first.
|
Sorry @bmorelli25. This PR wasn't ready for a writer review. 😞 I'll push local changes, and then see which of your comments are still applicable. |
Co-authored-by: jackshirazi <[email protected]>
Co-authored-by: jackshirazi <[email protected]>
Co-authored-by: Jonas Kunz <[email protected]>
|
Thanks for your patience and collaboration here! I'll leave it up to your team when you want to merge this. It's good from my side! |
Closes https://github.com/elastic/obs-docs-team/issues/238
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
forof OpenTelemetry (Mini docs style guide) (internal doc).To do
@bmorelli25 high-level review of the approach (anything I should add before kicking this over to the dev team?)