[DOC] Restructure Pyroscope documentation and share content #3798
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
knylander-grafana
added
the
type/docs
3 tasks
tacole02
approved these changes
Dec 31, 2024
docs/sources/configure-server/storage/configure-disk-storage.md
Outdated
Show resolved
Hide resolved
|
|
||
| <!-- vale Grafana.Spelling = NO --> | ||
|
|
||
| [Brendan Gregg](https://www.brendangregg.com/flamegraphs.html), the creator of flame graphs, was inspired by the inability to view, read, and understand stack traces using the regular profilers to debug performance issues. |
aleks-p
reviewed
Jan 6, 2025
Co-authored-by: Aleksandar Petrov <[email protected]>
aleks-p
approved these changes
Jan 6, 2025
docs/sources/configure-server/storage/configure-disk-storage.md
Outdated
Show resolved
Hide resolved
docs/sources/configure-server/storage/configure-disk-storage.md
Outdated
Show resolved
Hide resolved
docs/sources/configure-server/storage/configure-object-storage-backend.md
Outdated
Show resolved
Hide resolved
|
|
||
| Continuous profiling is a systematic method of collecting and analyzing performance data from production systems. | ||
| [//]: # 'Shared content for the when to use continuous profiling.' | ||
| [//]: # 'This content is located in /pyroscope/docs/sources/shared/intro/continuous-profiling.md' |
There was a problem hiding this comment.
Are these comments a common practice or generated? Otherwise, perhaps it can be omitted as the next line is descriptive enough.
There was a problem hiding this comment.
It's a best practice when using the include files to make sure people understand where content comes from. Even if it's obvious in the include line itself, not everyone reads it.
The comments also provide a visual clue for where content is shared in a file. The comments don't appear in the final published HTML (unlike the <!-- comments).
Co-authored-by: Aleksandar Petrov <[email protected]>
knylander-grafana
added
the
backport release/v1.11
github-actions bot
pushed a commit
that referenced
this pull request
Jan 7, 2025
* Restructure Pyroscope documentation and share content * Fix typo * Fix heading match for profile types * Restructure for configure server * Apply suggestions from code review Co-authored-by: Taylor C <[email protected]> * Apply suggestions from code review * Apply suggestions from code review Co-authored-by: Aleksandar Petrov <[email protected]> * Apply suggestions from code review Co-authored-by: Aleksandar Petrov <[email protected]> --------- Co-authored-by: Taylor C <[email protected]> Co-authored-by: Aleksandar Petrov <[email protected]> (cherry picked from commit f9b116c)
3 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Restructure Pyroscope documentation to share content to other profiles-related content.
These changes will go live with the next Pyroscope release and should not be backported.
Notes for reviewer
Part of https://github.com/grafana/pyroscope-squad/issues/223 (reference the mind map linked in the issue for the file changes)
You can check out the PR using
gh pr checkout 3798in your local tempo repo.Changes to check:
Blocks these PRs: