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

WIP: Clean up docs in new and refactored content #6219

Merged
merged 8 commits into from
Jan 29, 2024

Conversation

clayton-cornell
Copy link
Contributor

@clayton-cornell clayton-cornell commented Jan 22, 2024

PR Description

This PR is for a general tidy of some topics. Focus is on:

  • Clean up table spacing - for readability in source
  • Remove empty spaces at the end of lines
  • Tidy up minor language use (don't vs do not, configuration vs config, and so on)
  • Replace the agent with the product name variable
  • Fix some bad canonical link definitions (broken when topics were moved in other PRs)
  • Fix some note formatting
  • Remove exclamation punctuation

Which issue(s) this PR fixes

Notes to the Reviewer

PR Checklist

  • CHANGELOG.md updated
  • Documentation added
  • Tests updated
  • Config converters updated

@clayton-cornell clayton-cornell added the type/docs Docs Squad label across all Grafana Labs repos label Jan 22, 2024
@clayton-cornell clayton-cornell requested a review from a team January 26, 2024 19:50
@clayton-cornell clayton-cornell marked this pull request as ready for review January 26, 2024 19:50
@clayton-cornell clayton-cornell changed the title Clean up docs in new and refactored content WIP: Clean up docs in new and refactored content Jan 26, 2024
@clayton-cornell clayton-cornell marked this pull request as draft January 26, 2024 20:00
@clayton-cornell clayton-cornell marked this pull request as ready for review January 26, 2024 20:22
@ptodev ptodev merged commit 2c4f3e1 into main Jan 29, 2024
10 checks passed
@ptodev ptodev deleted the docs/general-content-tidy branch January 29, 2024 10:08
@grafanabot
Copy link
Contributor

The backport to release-v0.39 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-6219-to-release-v0.39 origin/release-v0.39
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x 2c4f3e1c793f211e08ac0796becbbb48e726ef56
# Push it to GitHub
git push --set-upstream origin backport-6219-to-release-v0.39
git switch main
# Remove the local backport branch
git branch -D backport-6219-to-release-v0.39

Then, create a pull request where the base branch is release-v0.39 and the compare/head branch is backport-6219-to-release-v0.39.

@clayton-cornell
Copy link
Contributor Author

Cancelled backport to 0.39. Edits included new content that isn't in 0.39. Changes are cleanup, so no new content. This can be published with 0.40.

BarunKGP pushed a commit to BarunKGP/grafana-agent that referenced this pull request Feb 20, 2024
* General cleanup of spaces and structure

* Fix canonical link

* Clean up empty spaces and syntax

* Convert HTML images containers to markdown

* Clean up tables, refs, extra spaces, and config

* Clean up tables, spacing, word use

* Revert image links
@github-actions github-actions bot added the frozen-due-to-age Locked due to a period of inactivity. Please open new issues or PRs if more discussion is needed. label Feb 29, 2024
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Feb 29, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
frozen-due-to-age Locked due to a period of inactivity. Please open new issues or PRs if more discussion is needed. type/docs Docs Squad label across all Grafana Labs repos
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants