-
Notifications
You must be signed in to change notification settings - Fork 656
[DOC] Updated intro and analyze sections #2855
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
[DOC] Updated intro and analyze sections #2855
Conversation
Time | ||
: Profiling data is collected _continuously_, providing a time-centric view that allows querying performance data from any point in the past. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This markdown format creates a term and definition list like this (except GitHub markdown doesn't support it)
Term
: Definition
The following sections describe Pyroscope UI capabilities. | ||
|
||
<!-- Add a screenshot with numbered parts for each of the sections described below. --> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think adding a screenshot with numbered sections that relate to all of the sections below would be very useful.
@@ -3,96 +3,35 @@ title: Analyze app performance using Pyroscope | |||
menuTitle: Analyze app performance | |||
description: How to use the Pyroscope UI to analyze performance of your applications. | |||
weight: 40 | |||
draft: true |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This page needs more information about how to use Pyroscope to analyze content. Instead of holding up this PR, I've set this page to draft: true so the content won't be published.
Note that if you do a local build with make docs, this page won't show up. You have to remove this line for it to show up in preview builds.
Doc issue for this task: #2856
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would be in favor of merging this and creating issues for the placeholders that need to be filled it
Agreed. I started doing that for some of the missing conte.t I'll do that for the rest. |
Restructures content for the Ingest and analyze data and introduction sections.
Fixes #2794