Commit graph

5 commits

Author SHA1 Message Date
Jack Baldry
1735db4c3b
Update all links to use docs/reference style (#2456)
# What this PR does

The `docs/reference` shortcode supports contextual destinations and
version inference.

`<ONCALL VERSION>` is inferred to match the version of the documentation
set. For example, the inferred version for the page
/docs/grafana/oncall/latest/get-started/ is "latest". It can also be
overriden using front matter.
Given the same page, but with the additional front matter
`oncall_version: next`, the variable is substituted with "next" rather
than "latest".

Contextual destinations are achieved using repeated labels in the
shortcode inner text. The format is [<LABEL>]: "<PAGE PATH PREFIX> ->
<HUGO REFERENCE>".

- _`<LABEL>`_ matches the reference style link label used in the rest of
the text.
- _`<PAGE PATH PREFIX>`_ is matched against the page during the
production build. If the match is successful, the destination that is
used is _`<HUGO REFERENCE>`_. The first matching prefix is used, not the
longest matching prefix.

## Which issue(s) this PR fixes

- Broken links due to ambiguous relref resolution. Any relref parameter
that does not start with either `/`, `./`, or `../` can resolve
ambiguously and is resulting in broken link behavior on the current
site.
- Broken links in Grafana Cloud. We mount OnCall documentation in
Grafana Cloud. In https://github.com/grafana/website/pull/13872 the
location will become /docs/grafana-cloud/alerting-and-irm/oncall. This
PR is intended to be merged alongside that PR.

---------

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
Co-authored-by: Joey Orlando <joey.orlando@grafana.com>
2023-07-13 14:38:35 +00:00
Jack Baldry
03d5402350
Update team name: grafana/docs-oncall is now grafana/docs-gops (#2512)
# What this PR does

Fixes the CODEOWNERS file which is marked as invalid because of the team
name change.

The team will need to be given write access to the repository by a
repository admin.

https://github.com/orgs/grafana/teams/docs-gops is the team.

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
2023-07-12 07:16:07 -04:00
Joey Orlando
3ce2173eff
tag @grafana/docs-oncall instead of oncall-backend for docs related changes (#1251)
Adding in reference to #1239.

@grafana/docs-oncall should be tagged as a PR reviewer for changes to
`/docs` rahter than @grafana/grafana-oncall-backend.
2023-01-31 09:34:29 +01:00
Joey Orlando
8609f415b3
don't tag oncall-backend when CHANGELOG is updated (#1250)
# What this PR does

There is no need to add `@grafana/grafana-oncall-backend` as a PR
reviewer when `CHANGELOG.md` is updated

## Which issue(s) this PR fixes

## Checklist

- [ ] Tests updated (N/A)
- [ ] Documentation added (N/A)
- [ ] `CHANGELOG.md` updated (N/A)
2023-01-30 12:36:21 +01:00
Joey Orlando
244a88d5cc
add CODEOWNERS file 2022-11-29 18:28:33 +01:00