Skip to content

[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

Merged

Conversation

knylander-grafana
Copy link
Contributor

Restructures content for the Ingest and analyze data and introduction sections.

Fixes #2794

@knylander-grafana knylander-grafana added the type/docs Improvements for doc docs. Used by Docs team for project management label Dec 15, 2023
@knylander-grafana knylander-grafana self-assigned this Dec 15, 2023
@knylander-grafana knylander-grafana requested review from a team as code owners December 15, 2023 03:54
Comment on lines +21 to +22
Time
: Profiling data is collected _continuously_, providing a time-centric view that allows querying performance data from any point in the past.
Copy link
Contributor Author

@knylander-grafana knylander-grafana Dec 15, 2023

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

Comment on lines +34 to +36
The following sections describe Pyroscope UI capabilities.

<!-- Add a screenshot with numbered parts for each of the sections described below. -->
Copy link
Contributor Author

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
Copy link
Contributor Author

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

Copy link
Contributor

@Rperry2174 Rperry2174 left a 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

@knylander-grafana
Copy link
Contributor Author

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.

@knylander-grafana knylander-grafana merged commit 3d54b5f into grafana:main Dec 15, 2023
@knylander-grafana knylander-grafana deleted the 2770-intro-content-review branch April 19, 2024 03:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type/docs Improvements for doc docs. Used by Docs team for project management
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[DOC] Restructure / Refine new profiling docs
2 participants