[8.x](backport #4230) [apm] Update APM section information architecture #4353
+3,106
−2,859
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes https://github.com/elastic/obs-docs-projects/issues/260
Closes https://github.com/elastic/observability-docs/issues/817
Updates the information architecture of the APM section.
Preview: https://observability-docs_bk_4230.docs-preview.app.elstc.co/guide/en/observability/master/apm.html
Approach
User-facing changes:
Contributor-related changes:
included at the bottom of the file associated with the parent page.apmdirectory.New content
I wrote some new content on new “landing” pages for subsections within the APM section. These need closer review.
Goals
I had a few goals with these pages:
Pages to be reviewed
Here are the pages with new content that need review:
Describes the relationship between event types in both the text and a diagram.
Presents alternative methods for collecting data and helps the user decide which page(s) might be relevant to them to streamline their experience.
Lists available agents and links to the docs. Mentions that for the most part, they should get information from the agent docs, but there are a couple resources in the Observability guide with content that applies to multiple agents and/or the APM UI.
Establishes that they might want to progress through this content in order as they get more familiar with the APM UI.
Establishes why this is important.
Review checklist
Rough checklist for now!
TO DOsThis is an automatic backport of pull request [apm] Update APM section information architecture #4230 done by Mergify.