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.41] Format with prettier #7118

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.41-jdb/2025-02-reverse-prettier-changes branch from 6eba548 to 7732bab Compare February 18, 2025 12:24
Copy link
Contributor

This PR has not had any activity in the past 30 days, so the needs-attention label has been added to it.
If you do not have enough time to follow up on this PR or you think it's no longer relevant, consider closing it.
The needs-attention label signals to maintainers that something has fallen through the cracks. No action is needed by you; your PR will be kept open and you do not have to respond to this comment. The label will be removed the next time this job runs if there is new activity.
Thank you for your contributions!

@github-actions github-actions bot added the needs-attention An issue or PR has been sitting around and needs attention. label Apr 10, 2025
@jdbaldry jdbaldry closed this Apr 10, 2025
@jdbaldry jdbaldry deleted the grafana-agent-v0.41-jdb/2025-02-reverse-prettier-changes branch April 10, 2025 07:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
needs-attention An issue or PR has been sitting around and needs attention. 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