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

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

Closed
bmorelli25 opened this issue Mar 17, 2020 · 2 comments · Fixed by #63280
Closed

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

bmorelli25 opened this issue Mar 17, 2020 · 2 comments · Fixed by #63280
Assignees
Labels
release_note:skip Skip the PR/issue when compiling release notes Team:APM All issues that need APM UI Team support v7.7.0

Comments

@bmorelli25
Copy link
Member

bmorelli25 commented Mar 17, 2020

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

  • Separate non-reference content from reference content -- Can we identify important tasks and create new task based guides? Topics like: Set up machine learning integrations, Create alerts, Configure APM Agents, Investigate slow requests, Investigate errors, etc.
  • Improve TOC structure and headings -- We should move content out from the "Using APM" bucket and make use of table abbreviations to simplify the TOC headings.

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".

  • Get started
  • Navigate the APM app (content from Using APM & Visualizing Application Bottlenecks)
    -- Services overview
    -- Traces overview
    -- Transaction overview
    -- Span timeline
    -- Errors overview
    -- Metrics overview
    -- Filters
    -- Advanced queries
  • How-to guides
    -- Configure APM Agents in Kibana
    -- Create a custom link
    -- Integrate with machine learning
    -- Query in the Discover app
  • Settings
  • API
    -- Agent Configuration API
  • Troubleshoot

Related Issues

@bmorelli25 bmorelli25 added Team:APM All issues that need APM UI Team support release_note:skip Skip the PR/issue when compiling release notes labels Mar 17, 2020
@bmorelli25 bmorelli25 self-assigned this Mar 17, 2020
@elasticmachine
Copy link
Contributor

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

@bmorelli25
Copy link
Member Author

Added a potential content layout, and additional context based on questions in elastic/apm-server#3492 (comment).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
release_note:skip Skip the PR/issue when compiling release notes Team:APM All issues that need APM UI Team support v7.7.0
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants