Skip to content
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.

Sign up for GitHub

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

Docs: move examples into code blocks #397

Merged
merged 1 commit into from
Dec 7, 2023
Merged

Docs: move examples into code blocks #397

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 22 additions & 6 deletions docs/sources/write/links/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,8 +57,11 @@ cascade:

Start with `https://grafana.com/docs/grafana/<GRAFANA_VERSION>/`, and add the rest of the URL path.

For example, to link to the [Developers](https://grafana.com/docs/grafana/latest/developers) page with version substitution,
use `https://grafana.com/docs/grafana/<GRAFANA_VERSION>/developers/`.
For example, to link to the [Developers](https://grafana.com/docs/grafana/latest/developers) page with version substitution, use:

```markdown
https://grafana.com/docs/grafana/<GRAFANA_VERSION>/developers/
```

- If you're linking from Grafana documentation, `<GRAFANA_VERSION>` is substituted with the version inferred from the page's URL.
- If you're linking from other documentation, `<GRAFANA_VERSION>` is substituted with the value of `GRAFANA_VERSION` from the source page's front matter.
Expand All @@ -67,22 +70,35 @@ use `https://grafana.com/docs/grafana/<GRAFANA_VERSION>/developers/`.

Grafana Cloud documentation is not versioned so no version substitution syntax is needed.
Use the full URL.
For example, to link to the [Author and run tests](https://grafana.com/docs/grafana-cloud/k6/author-run/) page, use `https://grafana.com/docs/grafana-cloud/k6/author-run/`.

For example, to link to the [Author and run tests](https://grafana.com/docs/grafana-cloud/k6/author-run/) page, use:

```markdown
https://grafana.com/docs/grafana-cloud/k6/author-run/
```

**Link to Mimir documentation**:

Start with `https://grafana.com/docs/grafana/<MIMIR_VERSION>/`, and add the rest of the URL path.

For example, to link to the [Release notes](https://grafana.com/docs/mimir/latest/release-notes/) page with version substitution,
use `https://grafana.com/docs/mimir/<MIMIR_VERSION>/release-notes/`.
For example, to link to the [Release notes](https://grafana.com/docs/mimir/latest/release-notes/) page with version substitution, use:

```markdown
https://grafana.com/docs/mimir/<MIMIR_VERSION>/release-notes/
```

- If you're linking from Mimir documentation, `<MIMIR_VERSION>` is substituted with the version inferred from the page's URL.
- If you're linking from other documentation, `<MIMIR_VERSION>` is substituted with the value of `MIMIR_VERSION` from the source page's front matter.

## Link to external pages

Use the full URL.
For example, `https://github.com`.

For example:

```markdown
https://github.com
```

## Link to page headings

Expand Down
Loading