Replace dashboard section with shorter description in introduction #199
Conversation
This file contains hidden or 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
Co-authored-by: JoanneOFlynn2018 <45287002+JoanneOFlynn2018@users.noreply.github.com>
Removed link to deleted reference file.
JoanneOFlynn2018
approved these changes
Jun 8, 2021
JoanneOFlynn2018
added a commit
that referenced
this pull request
Jun 8, 2021
) * replace dashboard section with shorter description in introduction * Update doc-Service-Telemetry-Framework/modules/con_dashboards.adoc Co-authored-by: JoanneOFlynn2018 <45287002+JoanneOFlynn2018@users.noreply.github.com> * better wording * Inserted cross references. (#200) Removed link to deleted reference file. Co-authored-by: JoanneOFlynn2018 <45287002+JoanneOFlynn2018@users.noreply.github.com>
JoanneOFlynn2018
added a commit
that referenced
this pull request
Jun 8, 2021
) (#201) * replace dashboard section with shorter description in introduction * Update doc-Service-Telemetry-Framework/modules/con_dashboards.adoc Co-authored-by: JoanneOFlynn2018 <45287002+JoanneOFlynn2018@users.noreply.github.com> * better wording * Inserted cross references. (#200) Removed link to deleted reference file. Co-authored-by: JoanneOFlynn2018 <45287002+JoanneOFlynn2018@users.noreply.github.com> Co-authored-by: pleimer <41337120+pleimer@users.noreply.github.com>
Closed
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.
I propose we delete the section in the docs describing each individual panel within the infrastructure dashboard and replace it with a short description of the dashboard in the introduction. Additionally, add a description of the cloud view dashboard in the introduction since we support it.
The section is hardly useful because it is way out of date and not reflective of the current state of the dashboard. Additionally, providing explanations of what each metric is is not really our responsibility; an admin should view the collectd or kernel docs to find more information. Anyone who gets as far as deploying the dashboards should have a pretty good understanding of what each metric is measuring anyway. Besides, there are short descriptions of each panel in the info section in the dashboards.