Docs: aligning with style guide #878
Conversation
|
TruffleHog Scan Results No secrets detected in this PR. |
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
| dashboards to PDFs to share with business stakeholders, or set up automatic | ||
| exports for Slack alert notifications, so you see your failing alerts with | ||
| context. Some features are exclusive to Grafana Enterprise and Grafana Cloud. | ||
| The [Grafana Image Renderer service][github] enables you to render Grafana panels and dashboards as PNGs, PDFs, or CSV files. |
Check failure
Code scanning / Vale
Did you really mean 'PNGs'? The Grafana dictionary might not know of this word yet Error documentation
| format. This is used to authenticate to the tracing backend. | ||
| - `--tracing.client-key`: path to the client private key file in PEM format. | ||
| - **`--tracing.trusted-certificate`**: Path to the trusted CA certificate file in PEM format. | ||
| This is used to verify the tracing backend's certificate. |
Check failure
Code scanning / Vale
Did you really mean 'backend's'? The Grafana dictionary might not know of this word yet Error documentation
| On some environments, such as in Docker, Kubernetes, or other container and VM | ||
| runtimes, further configuration may be required to pass the GPU through to the | ||
| service. | ||
| On some environments, such as Docker, Kubernetes, or other container and VM runtimes, you may need further configuration to pass the GPU through to the service. |
Check failure
Code scanning / Vale
Did you really mean 'runtimes'? The Grafana dictionary might not know of this word yet Error documentation
| [releases]: https://github.com/grafana/grafana-image-renderer/releases | ||
|
|
||
| ## Using Docker without Grafana being dockerised | ||
| ## Use Docker without Grafana being dockerised |
Check failure
Code scanning / Vale
Did you really mean 'dockerised'? The Grafana dictionary might not know of this word yet Error documentation
| service, which can be found via running either `eval echo ~username` (for | ||
| example: `eval echo ~grafana`), or via `getent passwd username` (for example: | ||
| `getent passwd grafana`). Run the following for that user: | ||
| You will also need to know the `$HOME` directory of the user running the service, which can be found via running either `eval echo ~<username>` (for example: `eval echo ~grafana`) or `getent passwd <username>` (for example: `getent passwd grafana`). |
Check warning
Code scanning / Vale
Avoid using 'will'. For more information, refer to https://developers.google.com/style/tense. Warning documentation
| You might also need other tooling. The error message will likely indicate what | ||
| is missing from your environment. | ||
| You might also need other tooling. | ||
| The error message will likely indicate what is missing from your environment. |
Check warning
Code scanning / Vale
Avoid using 'will'. For more information, refer to https://developers.google.com/style/tense. Warning documentation
| This is most commonly caused by using the old PDF rendering engine in Grafana. | ||
| To identify whether this applies to you, check whether the `newPDFRendering` | ||
| feature flag has been explicitly set to `false` in Grafana's configuration. | ||
| To identify whether this applies to you, check whether the `newPDFRendering` feature flag has been explicitly set to `false` in Grafana's configuration. |
Check warning
Code scanning / Vale
Don't form a possessive from a feature name, product name, or trademark, regardless of who owns it. For more information, refer to https://developers.google.com/style/possessives#product,-feature,-and-company-names. Warning documentation
|
🐳 Docker image built and pushed to GitHub Container Registry. You can pull it using: docker pull ghcr.io/grafana/grafana-image-renderer:dev-pull-878-5f9c6c2f3bcfb1fb8d6ae5c0591c0f00d4a6557bWarning This is a development image and should not be used in production. |
2 participants
This PR aligns the docs more closely to the guidelines in the writers toolkit. A fair amount of the edits are just implementing semantic line breaks in various places but there are some wording adjustments (introducing contractions, changing language to be more imperative, etc).