elastic / kibana

Your window into the Elastic Stack
https://www.elastic.co/products/kibana
Other
19.67k stars 8.23k forks source link

[apm][docs] Improve APM documentation structure and content #60462

Closed bmorelli25 closed 4 years ago

bmorelli25 commented 4 years ago

As a prerequisite to the Observability documentation overhaul, we should begin to:

Why?

Eventually, in the new Observability documentation, reference content will live separately from non-reference. We need a triage location for our guide content as we adapt what we have into how-to guides, and begin to create more task-focussed documentation.

New structure

A new structure for our current content could look like this. Additional work would still need to be done to adapt the content under the "Navigate the APM app section".

Related Issues

elasticmachine commented 4 years ago

Pinging @elastic/apm-ui (Team:apm)

bmorelli25 commented 4 years ago

Added a potential content layout, and additional context based on questions in https://github.com/elastic/apm-server/pull/3492#issuecomment-604646916.