centralcloud/oncall-engine
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
oncall-engine/docs
History
Joey Orlando 8ecc1de540
improve RBAC documentation (#2489) 
# What this PR does

closes https://github.com/grafana/oncall-private/issues/1953

- Improves RBAC for OnCall documentation + adds a [brief demo
video](https://www.loom.com/share/bcc472b2a22f40bdb62baf2a85cf1532) +
adds a table of the available RBAC roles and which actions they grant

![Screenshot 2023-07-11 at 11 14
29](https://github.com/grafana/oncall/assets/9406895/6d395536-175d-4ed0-9041-c2b1c7405fa4)
![Screenshot 2023-07-11 at 11 14
43](https://github.com/grafana/oncall/assets/9406895/66423995-a009-4dd7-a861-e6ba4dffc5d1)


- Add a small Python utility script to auto-generate the markdown table
from the `plugin.json` (otherwise this is really manual to compile by
hand)

## Checklist

- [ ] Unit, integration, and e2e (if applicable) tests updated (N//A)
- [x] Documentation added (or `pr:no public docs` PR label added if not
required)
- [ ] `CHANGELOG.md` updated (or `pr:no changelog` PR label added if not
required) (N//A)
2023-07-15 10:26:25 -04:00
..
img Merge dev to main (#73) 2022-06-14 09:54:41 -06:00
sources improve RBAC documentation (#2489) 2023-07-15 10:26:25 -04:00
.markdownlint.json Update all links to use docs/reference style (#2456) 2023-07-13 14:38:35 +00:00
docs.mk Update all links to use docs/reference style (#2456) 2023-07-13 14:38:35 +00:00
make-docs Update all links to use docs/reference style (#2456) 2023-07-13 14:38:35 +00:00
Makefile Use centralized make-docs script from Writers' Toolkit (#1742) 2023-04-24 08:52:43 +00:00
README.md Mobile app docs updates (#2026) 2023-05-29 14:52:42 +00:00
variables.mk Update all links to use docs/reference style (#2456) 2023-07-13 14:38:35 +00:00

README.md

Grafana Cloud Documentation

Source for documentation at https://grafana.com/docs/oncall/

Preview the website

Run make docs. This launches a preview of the website with the current grafana docs at http://localhost:3002/docs/oncall/latest/ which will refresh automatically when changes are made to content in the sources directory. Make sure Docker is running.

Image support

See the documentation in writers toolkit about how to store images