Update documentation to improve visibility and avoid duplicates with Grafana documentation #277
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
README.md
Outdated
Comment on lines
22
to
26
| Minimum free memory recommendation is 16GB on the system doing the rendering. | ||
|
|
||
| Rendering images can require a lot of memory, mainly because Grafana creates browser instances in the background for the actual rendering. If multiple images are rendered in parallel, then the rendering has a bigger memory footprint. One advantage of using the remote rendering service is that the rendering will be done on the remote system, so your local system resources will not be affected by rendering. | ||
|
|
||
| ## Plugin installation |
There was a problem hiding this comment.
Suggested change
| Minimum free memory recommendation is 16GB on the system doing the rendering. | |
| Rendering images can require a lot of memory, mainly because Grafana creates browser instances in the background for the actual rendering. If multiple images are rendered in parallel, then the rendering has a bigger memory footprint. One advantage of using the remote rendering service is that the rendering will be done on the remote system, so your local system resources will not be affected by rendering. | |
| ## Plugin installation | |
| Rendering images require a lot of memory, mainly because Grafana creates browser instances in the background for the actual rendering. | |
| We recommend a minimum of 16GB of free memory on the system rendering mages. | |
| To render multiple images in parallel requires an even bigger memory footprint. You can use the remote rendering service where images render on the remote system, and your local system resources are not affected. | |
| ## Installation |
There was a problem hiding this comment.
Applied this with some updates as I had trouble understanding the last paragraph.
AgnesToulet
commented
Sep 2, 2021
Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com>
achatterjee-grafana
approved these changes
Sep 2, 2021
|
Great, thanks! I'll wait for the Grafana PR to be approved to merge both PRs around the same time (as some contents were moved between the two docs and there are a lot of links between these docs). |
neverping
added a commit
to neverping/helm-charts
that referenced
this pull request
Jan 6, 2022
The image renderer plugin-in was linking to a broken documentation. After inspecting the changes on the `grafana-image-render repository`, I found out that the change below updated most of the documentation, where the content of the `remote_rendering_using_docker.md` was moved to the main `README.md` file. grafana/grafana-image-renderer#277
joshmeranda
pushed a commit
to joshmeranda/rancher-charts
that referenced
this pull request
Sep 22, 2023
This commit updates the Grafana Helm chart documentation. In the section about the image renderer plugin, the reference was linking to a broken documentation in another GitHub repository. After inspecting the changes on the `grafana-image-render` repository, I found out that the change below updated most of the documentation, where the content of the `remote_rendering_using_docker.md` was moved to the main `README.md` file. Then, this fix points towards the new reference. Here it is the commit that changed the documentation on the remote repo. grafana/grafana-image-renderer#277 Signed-off-by: Willian Braga <willian.braga@sybogames.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR does the following documentation update:
remote_rendering_using_docker.mdfile to improve its visibility (mainly in the new image rendering configuration section in Grafana documentation).To be merged with this OSS PR: grafana/grafana#38759