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

[DOC] Restructure operations and manage docs #4598

Merged

Conversation

knylander-grafana
Copy link
Contributor

@knylander-grafana knylander-grafana commented Jan 23, 2025

What this PR does:
Restructures the Manage Tempo docs in the operations folder.
image

Major changes:

  • Creates a new manage-advanced-systems folder in the operations folder and moved several files into the new directory.
  • Updates the links and aliases for any moved or deleted files (note that the serverless content is removed in another PR; this one is only mirroring that change for doing page weights)
  • Adds a new shared file for tempo-in-grafana. This content will be used in Grafana Cloud Traces content.
  • Fixes some links and minor linting issues in other docs.
  • The best practices content was moved from operations to getting started.

Notes to reviewer:

  • Please check the page weights against the mind map.
  • Verify that aliases worked for the moved or deleted pages (except for the two serverless*.md files).

Which issue(s) this PR fixes:
Related to https://github.com/grafana/tempo-squad/issues/468

Checklist

  • Tests updated
  • Documentation added
  • CHANGELOG.md updated - the order of entries should be [CHANGE], [FEATURE], [ENHANCEMENT], [BUGFIX]

@knylander-grafana knylander-grafana added the type/docs Improvements or additions to documentation label Jan 23, 2025
@knylander-grafana knylander-grafana self-assigned this Jan 23, 2025
@@ -3,6 +3,8 @@ title: Manage Tempo
menuTitle: Manage
description: Learn how to manage and tune Tempo.
weight: 450
aliases:
- ./ingester_pvcs/ # https://grafana.com/docs/tempo/next/operations/ingester_pvcs/
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Alias for deleted page.

@knylander-grafana knylander-grafana mentioned this pull request Jan 23, 2025
3 tasks
Copy link
Contributor

@chri2547 chri2547 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

a few nits!

Co-authored-by: Christopher Moyer <[email protected]>
@electron0zero electron0zero merged commit da9b5ff into grafana:main Jan 27, 2025
14 checks passed
@knylander-grafana knylander-grafana added the backport release-v2.7 Backport for V2.7 label Jan 27, 2025
Copy link
Contributor

The backport to release-v2.7 failed:

The process '/usr/bin/git' failed with exit code 1

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new branch
git switch --create backport-4598-to-release-v2.7 origin/release-v2.7
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x da9b5ffa368a0376182017290a741ce17cb9997c

When the conflicts are resolved, stage and commit the changes:

git add . && git cherry-pick --continue

If you have the GitHub CLI installed:

# Push the branch to GitHub:
git push --set-upstream origin backport-4598-to-release-v2.7
# Create the PR body template
PR_BODY=$(gh pr view 4598 --json body --template 'Backport da9b5ffa368a0376182017290a741ce17cb9997c from #4598{{ "\n\n---\n\n" }}{{ index . "body" }}')
# Create the PR on GitHub
echo "${PR_BODY}" | gh pr create --title '[release-v2.7] [DOC] Restructure operations and manage docs' --body-file - --label 'type/docs' --label 'backport' --base release-v2.7 --milestone release-v2.7 --web

Or, if you don't have the GitHub CLI installed (we recommend you install it!):

# Push the branch to GitHub:
git push --set-upstream origin backport-4598-to-release-v2.7

# Create a pull request where the `base` branch is `release-v2.7` and the `compare`/`head` branch is `backport-4598-to-release-v2.7`.

# Remove the local backport branch
git switch main
git branch -D backport-4598-to-release-v2.7

knylander-grafana added a commit that referenced this pull request Jan 27, 2025
* Restructure operations and manage docs

* Fix page weights and links

* Fix links and some linting issues

* Apply suggestions from code review

Co-authored-by: Christopher Moyer <[email protected]>

* Add new headings for tempo-in-grafana

---------

Co-authored-by: Christopher Moyer <[email protected]>
(cherry picked from commit da9b5ff)
knylander-grafana added a commit that referenced this pull request Jan 31, 2025
* Restructure operations and manage docs

* Fix page weights and links

* Fix links and some linting issues

* Apply suggestions from code review

Co-authored-by: Christopher Moyer <[email protected]>

* Add new headings for tempo-in-grafana

---------

Co-authored-by: Christopher Moyer <[email protected]>
(cherry picked from commit da9b5ff)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport release-v2.7 Backport for V2.7 backport-failed type/docs Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants