-
Notifications
You must be signed in to change notification settings - Fork 512
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
Conversation
Signed-off-by: Marco Pracucci <marco@pracucci.com>
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. |
User error, need to reopen. |
Will commit directly to this branch per your suggestion on Slack. In doing so, I will provide rationale for each change. |
There was a problem hiding this 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.
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:
Which issue(s) this PR fixes:
Fixes #909
Checklist
CHANGELOG.md
updated - the order of entries should be[CHANGE]
,[FEATURE]
,[ENHANCEMENT]
,[BUGFIX]