Improve current monitor section documentation page
Problem to solve
- re-organize monitor / observability documentation section to account for the new features introduced recently
- improve navigation, clarify stage offering, future-proof this doc section
Proposal
A/ Rename and re-order current information structure:
-
Rename “Monitor app performance” to “Monitor your application”
- This way, it will align with other section names (“Secure your application", “Use CI/CD to build your application”...)
-
Rename and move “Analyze GitLab Usage > Metrics” to “Administer > Monitor your installation”:
- To avoid confusion with “Monitor your application > Metrics”” and to make it more aligned with the rest of the docs information architecture.
-
Move “Monitor runner performance” to "Use CI/CD to build your application > Runners"
- Alongside other runners-related pages like "Manage runners", "Configure runners".
- This way, it is removed from the monitor section of the "get started" diagram.
This way, the content of the landing page “Monitor your application” would be:
Visualize and analyze errors, traces, metrics and logs collected from your application and its infrastructure. Monitor, identify and resolve performance issues and incidents collaboratively.
(note the incident management sub-menu that would hide the less important features in a collapsed navigation menu) |
Proposed diagram with this new architecture:
B/ Create an introductory "getting started" page
As proposed in !148338 (comment 1901199299)
Detailed content still to be defined - current draft here.
Open Questions
- Product Analytics documentation is currently buried into "Analyze GitLab Usage". Do we have a plan to move it somewhere else ie. in this same section?
- Having a "getting started" page at the section level requires to include Observability, Error Tracking and Incident Management features. How can we structure this page taking into account these different features?
Edited by Sacha Guyon