Skip to content
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

[release/v1.11] [DOC] Restructure Pyroscope documentation and share content #3821

Merged
merged 1 commit into from
Jan 7, 2025

Conversation

github-actions[bot]
Copy link
Contributor

@github-actions github-actions bot commented Jan 7, 2025

Backport f9b116c from #3798


Restructure Pyroscope documentation to share content to other profiles-related content.

  • Changes into content to shared files
  • Updates the Pyroscope UI content to include Explore Profiles
  • Restructures the Configure the server section - moves the API docs out to a new reference section, moves the two storage docs into a storage directory

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 3798 in your local tempo repo.

Changes to check:

  • Intro section now has shared content. Please verify that the correct content shows in each page.
  • Check aliases in the front matter for moved pages
  • Check the page weights and order using the mind map as a guide.

Blocks these PRs:

* 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 <41653732+tacole02@users.noreply.github.com>

* Apply suggestions from code review

* Apply suggestions from code review

Co-authored-by: Aleksandar Petrov <8142643+aleks-p@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Aleksandar Petrov <8142643+aleks-p@users.noreply.github.com>

---------

Co-authored-by: Taylor C <41653732+tacole02@users.noreply.github.com>
Co-authored-by: Aleksandar Petrov <8142643+aleks-p@users.noreply.github.com>
(cherry picked from commit f9b116c)
@github-actions github-actions bot requested review from a team as code owners January 7, 2025 16:26
@github-actions github-actions bot added backport type/docs Improvements for doc docs. Used by Docs team for project management labels Jan 7, 2025
@knylander-grafana knylander-grafana merged commit 8e71eda into release/v1.11 Jan 7, 2025
1 check passed
@knylander-grafana knylander-grafana deleted the backport-3798-to-release/v1.11 branch January 7, 2025 16:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport 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.

1 participant