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

[v0.43] Format with prettier #7116

Draft
wants to merge 1 commit into
base: release-v0.43
Choose a base branch
from

Conversation

jdbaldry
Copy link
Member

Consistent formatting improves readability and makes it easier for tools to transform the source.

The general human understanding of Markdown has some ambiguities so it's possible this PR will break some documentation presentation because the formatter follows the CommonMark specification.
Elminating this ambiguity provides more consistent behavior and makes it easier for future readers to understand your Markdown.

Consistent formatting is also necessary to provide meaningful diffs in future automated PRs.
If you would like to benefit from automated improvements made by the Docs Platform team, you must adopt prettier in your local development and enforce it in CI.

If you would like help running prettier in CI, reach out in the #docs-platform Slack channel.

Created-By: reverse-changes
Repository: grafana/agent
Website-Pull-Request: https://github.com/grafana/website/pull/24071

@jdbaldry jdbaldry added the type/docs Docs Squad label across all Grafana Labs repos label Feb 18, 2025
Consistent formatting improves readability and makes it easier for tools to transform the source.

The general human understanding of Markdown has some ambiguities so it's possible this PR will break some documentation presentation because the formatter follows the CommonMark specification.
Elminating this ambiguity provides more consistent behavior and makes it easier for future readers to understand your Markdown.

Consistent formatting is also necessary to provide meaningful diffs in future automated PRs.
If you would like to benefit from automated improvements made by the Docs Platform team, you must adopt `prettier` in your local development and enforce it in CI.

If you would like help running `prettier` in CI, reach out in the [#docs-platform Slack channel](https://raintank-corp.slack.com/archives/C07R2REUULS).

Created-By: reverse-changes
Repository: grafana/agent
Website-Pull-Request: grafana/website#24071
@jdbaldry jdbaldry force-pushed the grafana-agent-v0.43-jdb/2025-02-reverse-prettier-changes branch from 2f867ca to 6b29c44 Compare February 18, 2025 12:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type/docs Docs Squad label across all Grafana Labs repos
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant