oncall-engine/docs
Jack Baldry 9ae442faa6
Replace docs/reference shortcode with ref URIs (#4301)
You can use `ref` URIs in admonitions (or any shortcodes) because they
are inline and not subject to the issues noted in the [`admonition`
shortcode](https://grafana.com/docs/writers-toolkit/write/shortcodes/#code-shortcode:~:text=to%20core%20understanding.-,WARNING,For%20more%20information%2C%20refer%20to%20Markdown%20Reference%20Links%20in%20Shortcodes.,-Examples).

The `ref` URIs perform the same pattern matching as `docs/reference` but
don't require the use of reference-style links and the destinations are
ordinary (full) URLs that can include version substitution. Unlike
`docs/reference`, the implementation doesn't use `relref` so you don't
have to be careful with omitting trailing slashes and the links will
follow redirects.

Documentation:
https://grafana.com/docs/writers-toolkit/write/links/#link-from-source-content-thats-used-in-multiple-projects

To check the links, refer to the deploy preview in
https://github.com/grafana/website/pull/19630.

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

---------

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
2024-07-29 14:13:24 +00:00
..
img cleanup some unused images 2024-06-06 10:02:40 -04:00
sources Replace docs/reference shortcode with ref URIs (#4301) 2024-07-29 14:13:24 +00:00
.markdownlint.json Update all links to use docs/reference style (#2456) 2023-07-13 14:38:35 +00:00
docs.mk Update make docs procedure (#4523) 2024-06-13 20:30:35 +00:00
make-docs Update make docs procedure (#4523) 2024-06-13 20:30: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 make docs procedure (#2808) 2023-08-17 11:46:49 +00:00

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