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.

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

[release-2.9.x] Fixing broken links #11962

Merged
merged 1 commit into from
Feb 15, 2024

Conversation

grafanabot
Copy link
Collaborator

Backport c328a4f from #11956


Replaces #11923. For some reason I can't push updates to that PR, so opening a new one.

Which issue(s) this PR fixes:
Fixes broken links in https://grafana.com/docs/loki/latest/release-notes/cadence/

(cherry picked from commit c328a4f)
@grafanabot grafanabot requested a review from a team as a code owner February 15, 2024 14:41
@grafanabot grafanabot added backport size/XS type/docs Issues related to technical documentation; the Docs Squad uses this label across many repositories labels Feb 15, 2024
@grafanabot grafanabot requested a review from JStickler February 15, 2024 14:41
@@ -8,7 +8,7 @@ weight: 1

## Stable Releases

Loki releases (this includes [Promtail](/clients/promtail), [Loki Canary](/operations/loki-canary/), etc) use the following
Loki releases (this includes [Promtail](https://grafana.com/docs/loki/<LOKI_VERSION>/send-data/promtail/), [Loki Canary](https://grafana.com/docs/loki/<LOKI_VERSION>/operations/loki-canary/), etc.) use the following
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [doc-validator] reported by reviewdog 🐶
The link target 'https://grafana.com/docs/loki/<LOKI_VERSION>/send-data/promtail/' is invalid. Links to grafana.com pages must not include the hostname so that they can be resolved regardless of domain.
Links to grafana.com pages must be one of the following:

  • For linking to headings within the current page, use an anchor starting with a hash (#).
    For example, #heading.

  • For linking to other pages in the current documentation set, use a Hugo relref with either an absolute path or relative path parameter.
    Using a relative path parameter, for example, {{< relref "./path/to/page" >}} or {{ relref "../other/path" }}.
    Using an absolute path parameter, for example, {{< relref "/docs/grafana-cloud" >}}.

  • For linking to any other page in the https://grafana.com site, use a partial URI consisting of an absolute path.
    For example, /blogs/.

For an explanation of partial URIs, refer to https://www.w3.org/Addressing/URL/4_3_Partial.html.

@@ -8,7 +8,7 @@

## Stable Releases

Loki releases (this includes [Promtail](/clients/promtail), [Loki Canary](/operations/loki-canary/), etc) use the following
Loki releases (this includes [Promtail](https://grafana.com/docs/loki/<LOKI_VERSION>/send-data/promtail/), [Loki Canary](https://grafana.com/docs/loki/<LOKI_VERSION>/operations/loki-canary/), etc.) use the following
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [doc-validator] reported by reviewdog 🐶
The link target 'https://grafana.com/docs/loki/<LOKI_VERSION>/operations/loki-canary/' is invalid. Links to grafana.com pages must not include the hostname so that they can be resolved regardless of domain.
Links to grafana.com pages must be one of the following:

  • For linking to headings within the current page, use an anchor starting with a hash (#).
    For example, #heading.

  • For linking to other pages in the current documentation set, use a Hugo relref with either an absolute path or relative path parameter.
    Using a relative path parameter, for example, {{< relref "./path/to/page" >}} or {{ relref "../other/path" }}.
    Using an absolute path parameter, for example, {{< relref "/docs/grafana-cloud" >}}.

  • For linking to any other page in the https://grafana.com site, use a partial URI consisting of an absolute path.
    For example, /blogs/.

For an explanation of partial URIs, refer to https://www.w3.org/Addressing/URL/4_3_Partial.html.

@@ -17,13 +17,13 @@

> **NOTE:** While our naming scheme resembles [Semantic Versioning](https://semver.org/), at this time we do not strictly follow its
guidelines to the letter. Our goal is to provide regular releases that are as stable as possible, and we take backwards-compatibility
seriously. As with any software, always read the [release notes](/release-notes) and the [upgrade guide](/upgrading) whenever
seriously. As with any software, always read the [release notes](https://grafana.com/docs/loki/<LOKI_VERSION>/release-notes/) and the [upgrade guide](https://grafana.com/docs/loki/<LOKI_VERSION>/setup/upgrade/) whenever
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [doc-validator] reported by reviewdog 🐶
The link target 'https://grafana.com/docs/loki/<LOKI_VERSION>/release-notes/' is invalid. Links to grafana.com pages must not include the hostname so that they can be resolved regardless of domain.
Links to grafana.com pages must be one of the following:

  • For linking to headings within the current page, use an anchor starting with a hash (#).
    For example, #heading.

  • For linking to other pages in the current documentation set, use a Hugo relref with either an absolute path or relative path parameter.
    Using a relative path parameter, for example, {{< relref "./path/to/page" >}} or {{ relref "../other/path" }}.
    Using an absolute path parameter, for example, {{< relref "/docs/grafana-cloud" >}}.

  • For linking to any other page in the https://grafana.com site, use a partial URI consisting of an absolute path.
    For example, /blogs/.

For an explanation of partial URIs, refer to https://www.w3.org/Addressing/URL/4_3_Partial.html.

@@ -17,13 +17,13 @@

> **NOTE:** While our naming scheme resembles [Semantic Versioning](https://semver.org/), at this time we do not strictly follow its
guidelines to the letter. Our goal is to provide regular releases that are as stable as possible, and we take backwards-compatibility
seriously. As with any software, always read the [release notes](/release-notes) and the [upgrade guide](/upgrading) whenever
seriously. As with any software, always read the [release notes](https://grafana.com/docs/loki/<LOKI_VERSION>/release-notes/) and the [upgrade guide](https://grafana.com/docs/loki/<LOKI_VERSION>/setup/upgrade/) whenever
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [doc-validator] reported by reviewdog 🐶
The link target 'https://grafana.com/docs/loki/<LOKI_VERSION>/setup/upgrade/' is invalid. Links to grafana.com pages must not include the hostname so that they can be resolved regardless of domain.
Links to grafana.com pages must be one of the following:

  • For linking to headings within the current page, use an anchor starting with a hash (#).
    For example, #heading.

  • For linking to other pages in the current documentation set, use a Hugo relref with either an absolute path or relative path parameter.
    Using a relative path parameter, for example, {{< relref "./path/to/page" >}} or {{ relref "../other/path" }}.
    Using an absolute path parameter, for example, {{< relref "/docs/grafana-cloud" >}}.

  • For linking to any other page in the https://grafana.com site, use a partial URI consisting of an absolute path.
    For example, /blogs/.

For an explanation of partial URIs, refer to https://www.w3.org/Addressing/URL/4_3_Partial.html.

choosing a new version of Loki to install.

New releases are based of a [weekly release](#weekly-releases) which we have vetted for stability over a number of weeks.

We strongly recommend keeping up-to-date with patch releases as they are released. We post updates of new releases in the `#loki` channel
of our [Slack community](/community/getting-in-touch).
of our [Slack community](https://grafana.com/docs/loki/<LOKI_VERSION>/community/getting-in-touch/).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [doc-validator] reported by reviewdog 🐶
The link target 'https://grafana.com/docs/loki/<LOKI_VERSION>/community/getting-in-touch/' is invalid. Links to grafana.com pages must not include the hostname so that they can be resolved regardless of domain.
Links to grafana.com pages must be one of the following:

  • For linking to headings within the current page, use an anchor starting with a hash (#).
    For example, #heading.

  • For linking to other pages in the current documentation set, use a Hugo relref with either an absolute path or relative path parameter.
    Using a relative path parameter, for example, {{< relref "./path/to/page" >}} or {{ relref "../other/path" }}.
    Using an absolute path parameter, for example, {{< relref "/docs/grafana-cloud" >}}.

  • For linking to any other page in the https://grafana.com site, use a partial URI consisting of an absolute path.
    For example, /blogs/.

For an explanation of partial URIs, refer to https://www.w3.org/Addressing/URL/4_3_Partial.html.

@JStickler JStickler merged commit 3dba14c into release-2.9.x Feb 15, 2024
9 of 11 checks passed
@JStickler JStickler deleted the backport-11956-to-release-2.9.x branch February 15, 2024 14:49
@JStickler
Copy link
Contributor

@jdbaldry Any idea why doc-validator was failing on the branch, but not on main?

@jdbaldry
Copy link
Member

The workflow updates were not backported there in #11200. I've added the labels to that PR now.

@jdbaldry
Copy link
Member

#11965 🎉

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport size/XS type/docs Issues related to technical documentation; the Docs Squad uses this label across many repositories
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants