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

Clean up some of the linting warnings and errors #2155

Merged
merged 13 commits into from
Nov 27, 2024

Conversation

clayton-cornell
Copy link
Contributor

@clayton-cornell clayton-cornell commented Nov 25, 2024

PR Description

Clean up linting warnings and errors in the Alloy docs. Some issues (especially passive voice) remain in the various topics. It will take multiple passes to get the warnings/errors down to a manageable level.

Changes here include:

  • Fix some spelling
  • Add contractions
  • Delete duplicate links
  • Delete unused links
  • Fix broken or incorrect links
  • Fix up some of the passive voice and replace with more active statements
  • Tidy up some of the markdown style
  • Clean up some word use
  • Replace smart quotes
  • Remove trailing spaces
  • Remove extra blank lines between elements
  • Add missing trailing line at the end of the file
  • Add missing language to codefences
  • Add/remove spaces before/after codefences
  • Add/remove spaces before/after lists
  • Fix spacing/indentation
  • Make bullets * for consistency
  • Remove gerunds from headings
  • Clean up use of let's and we
  • Fix a spelling mistake in a file name and add an alias

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 Nov 26, 2024
@clayton-cornell clayton-cornell marked this pull request as ready for review November 26, 2024 19:03
@clayton-cornell
Copy link
Contributor Author

The linting cleanup isn't complete, but this PR is big enough as it is. Time for a review/merge.

@clayton-cornell clayton-cornell requested a review from a team November 26, 2024 19:04
@clayton-cornell clayton-cornell marked this pull request as draft November 27, 2024 14:45
@clayton-cornell clayton-cornell marked this pull request as ready for review November 27, 2024 17:28
docs/sources/collect/choose-component.md Show resolved Hide resolved
docs/sources/collect/datadog-traces-metrics.md Outdated Show resolved Hide resolved
docs/sources/collect/metamonitoring.md Outdated Show resolved Hide resolved
Co-authored-by: Beverly Buchanan <[email protected]>
@clayton-cornell clayton-cornell merged commit c27c8ac into main Nov 27, 2024
18 checks passed
@clayton-cornell clayton-cornell deleted the docs/fix-linting-warnings branch November 27, 2024 19:03
Copy link
Contributor

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

Then, create a pull request where the base branch is release/v1.5 and the compare/head branch is backport-2155-to-release/v1.5.

clayton-cornell added a commit that referenced this pull request Nov 27, 2024
* Clean up some of the linting warnings and errors

* Additional linting warning and error cleanup

* More work on removing linting errors

* More linting cleanup

* Even more linting warning cleanup

* Fix links to components

* Fix link syntax in topic

* Correct reference to AWS X-Ray

* Add missing link in collect topic

* Fix up some redirected links and minor syntax fixes

* Fix typo in file name

* Apply suggestions from code review

Co-authored-by: Beverly Buchanan <[email protected]>

---------

Co-authored-by: Beverly Buchanan <[email protected]>
(cherry picked from commit c27c8ac)
clayton-cornell added a commit that referenced this pull request Nov 27, 2024
* Clean up some of the linting warnings and errors

* Additional linting warning and error cleanup

* More work on removing linting errors

* More linting cleanup

* Even more linting warning cleanup

* Fix links to components

* Fix link syntax in topic

* Correct reference to AWS X-Ray

* Add missing link in collect topic

* Fix up some redirected links and minor syntax fixes

* Fix typo in file name

* Apply suggestions from code review

Co-authored-by: Beverly Buchanan <[email protected]>

---------

Co-authored-by: Beverly Buchanan <[email protected]>
(cherry picked from commit c27c8ac)
clayton-cornell added a commit that referenced this pull request Nov 28, 2024
…2179)

* Clean up some of the linting warnings and errors

* Additional linting warning and error cleanup

* More work on removing linting errors

* More linting cleanup

* Even more linting warning cleanup

* Fix links to components

* Fix link syntax in topic

* Correct reference to AWS X-Ray

* Add missing link in collect topic

* Fix up some redirected links and minor syntax fixes

* Fix typo in file name

* Apply suggestions from code review

Co-authored-by: Beverly Buchanan <[email protected]>

---------

Co-authored-by: Beverly Buchanan <[email protected]>
(cherry picked from commit c27c8ac)
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Dec 28, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants