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

docs: Fixing some Vale linter errors #15323

Merged
merged 2 commits into from
Dec 10, 2024
Merged

docs: Fixing some Vale linter errors #15323

merged 2 commits into from
Dec 10, 2024

Conversation

JStickler
Copy link
Contributor

What this PR does / why we need it:

Loki currently has 8,000+ Vale linter errors, so I'm working on fixing a few every week this quarter to try to bring that number down.

This PR touches three files and addresses some of the following:

  • Creates exception for use of "we" in tutorial topics
  • Changes headings from title case to sentence case
  • Missing empty lines before/after headings
  • Missing empty lines before/after code fences
  • Fixes a couple of typos
  • Fixes a couple of spacing issues

@JStickler JStickler added the type/docs Issues related to technical documentation; the Docs Squad uses this label across many repositories label Dec 9, 2024
@JStickler JStickler requested a review from a team as a code owner December 9, 2024 21:23
@JStickler JStickler merged commit 4fd005b into main Dec 10, 2024
59 checks passed
@JStickler JStickler deleted the 2024.12.09_valeLinting branch December 10, 2024 16:23
loki-gh-app bot pushed a commit that referenced this pull request Dec 10, 2024
loki-gh-app bot pushed a commit that referenced this pull request Dec 10, 2024
loki-gh-app bot pushed a commit that referenced this pull request Dec 10, 2024
loki-gh-app bot pushed a commit that referenced this pull request Dec 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport release-3.0.x backport release-3.1.x backport release-3.2.x backport release-3.3.x size/L type/docs Issues related to technical documentation; the Docs Squad uses this label across many repositories
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants