centralcloud/oncall-engine

Fork 0

Commit graph

Author	SHA1	Message	Date
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
Alyssa Wada	87dd4f90ad	refactor docs configuration section (#4646 ) # What this PR does Restructures OnCall documentation 'Configure' section ## Which issue(s) this PR closes Closes issue #4592	2024-07-25 15:22:39 +00:00
Alyssa Wada	80f932995c	oncall docs refactor (#3757 ) # What this PR does - Restructure the OnCall documentation to align with Grafana Labs [documentation structure guidance](https://grafana.com/docs/writers-toolkit/structure/). - Updates documentation front matter to include all required fields. ## Which issue(s) this PR fixes Related to issue #3700 ## Checklist - [ ] Unit, integration, and e2e (if applicable) tests updated - [ ] 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) --------- Signed-off-by: Jack Baldry <jack.baldry@grafana.com> Co-authored-by: Jack Baldry <jack.baldry@grafana.com>	2024-02-08 22:59:28 +00:00

Author

SHA1

Message

Date

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

Alyssa Wada

87dd4f90ad

refactor docs configuration section (#4646 )

# What this PR does
Restructures OnCall documentation 'Configure' section 

## Which issue(s) this PR closes
Closes issue #4592

2024-07-25 15:22:39 +00:00

Alyssa Wada

80f932995c

oncall docs refactor (#3757 )

# What this PR does

- Restructure the OnCall documentation to align with Grafana Labs
[documentation structure
guidance](https://grafana.com/docs/writers-toolkit/structure/).

- Updates documentation front matter to include all required fields.

## Which issue(s) this PR fixes
Related to issue #3700 

## Checklist

- [ ] Unit, integration, and e2e (if applicable) tests updated
- [ ] 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)

---------

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

2024-02-08 22:59:28 +00:00

3 commits