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

Document dashboards and alerts offered by the mixin #925

Merged
merged 2 commits into from
Feb 1, 2022

Conversation

pracucci
Copy link
Collaborator

What this PR does:
In this PR I'm proposing to add a couple of documentation pages to give some instructions about our dashboards and alerts.

I tried to do my best to follow these guidelines but since it's the first time writing doc based on that I may have done many mistakes.

Out of the scope of this PR:

  • Extract dashboard description from jsonnet sources
  • Add dashboard screenshots to the list of dashboards (I will try to automate the screenshot taking in a separate PR)

Which issue(s) this PR fixes:
Fixes #909

Checklist

  • Tests updated
  • Documentation added
  • CHANGELOG.md updated - the order of entries should be [CHANGE], [FEATURE], [ENHANCEMENT], [BUGFIX]

Signed-off-by: Marco Pracucci <marco@pracucci.com>
@osg-grafana
Copy link
Contributor

@chri2547, I would like to pair with you on this PR as a first go at aligning with our new refactored information architecture. @pracucci, this likely means that I will create a new PR and attempt to merge it into this one.

@osg-grafana osg-grafana added the type/docs Improvements or additions to documentation label Jan 27, 2022
Signed-off-by: Marco Pracucci <marco@pracucci.com>
@pracucci
Copy link
Collaborator Author

@pracucci, this likely means that I will create a new PR and attempt to merge it into this one.

I'm not sure to understand why you need to re-create this PR. To me would be more beneficial if you provide me feedback, so I can learn as well and apply learning in upcoming other documentation improvements.

@osg-grafana
Copy link
Contributor

osg-grafana commented Jan 27, 2022

@pracucci, this likely means that I will create a new PR and attempt to merge it into this one.

I'm not sure to understand why you need to re-create this PR. To me would be more beneficial if you provide me feedback, so I can learn as well and apply learning in upcoming other documentation improvements.

I intend to provide rationale for the changes to provide guidance about how we are thinking about information architecture, which is also quite new for us writers. I thought that a new PR might be the easiest way to accomplish that.

@osg-grafana
Copy link
Contributor

User error, need to reopen.

@osg-grafana osg-grafana reopened this Jan 27, 2022
@osg-grafana
Copy link
Contributor

@pracucci, this likely means that I will create a new PR and attempt to merge it into this one.

I'm not sure to understand why you need to re-create this PR. To me would be more beneficial if you provide me feedback, so I can learn as well and apply learning in upcoming other documentation improvements.

I intend to provide rationale for the changes to provide guidance about how we are thinking about information architecture, which is also quite new for us writers. I thought that a new PR might be the easiest way to accomplish that.

Will commit directly to this branch per your suggestion on Slack. In doing so, I will provide rationale for each change.

Copy link
Contributor

@osg-grafana osg-grafana left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approving so that I am not blocking folks.

@osg-grafana
Copy link
Contributor

@jdbaldry, we can take a subsequent look at this area of the docs in light of #732 when we have a chance to cover this area.

@pracucci pracucci merged commit 1dd5a34 into main Feb 1, 2022
@pracucci pracucci deleted the document-dashboards-and-alerts branch February 1, 2022 08:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type/docs Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docs: write dashboards and alerts documentation
2 participants