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] docs: Update _index.md addressing #11575 #11664

Merged
merged 1 commit into from
Jan 11, 2024

Conversation

grafanabot
Copy link
Collaborator

Backport 3b2278d from #11626


What this PR does / why we need it:
It improves the docs by addressing #11575 allowing users to use the official fluent-bit helm chart over the deprecated grafana one

Which issue(s) this PR fixes:
Fixes #11575

Special notes for your reviewer:
@JStickler wanted to take a look at this.

Checklist

  • [ x ] Reviewed the CONTRIBUTING.md guide (required)
  • [ x ] Documentation added
  • Tests updated
  • CHANGELOG.md updated
    • If the change is worth mentioning in the release notes, add add-to-release-notes label
  • Changes that require user attention or interaction to upgrade are documented in docs/sources/setup/upgrade/_index.md
  • For Helm chart changes bump the Helm chart version in production/helm/loki/Chart.yaml and update production/helm/loki/CHANGELOG.md and production/helm/loki/README.md. Example PR
  • If the change is deprecating or removing a configuration option, update the deprecated-config.yaml and deleted-config.yaml files respectively in the tools/deprecated-config-checker directory. Example PR

**What this PR does / why we need it**:
It improves the docs by addressing #11575 allowing users to use the
official fluent-bit helm chart over the deprecated grafana one

**Which issue(s) this PR fixes**:
Fixes #11575

**Special notes for your reviewer**:
@JStickler wanted to take a look at this.

**Checklist**
- [ x ] Reviewed the
[`CONTRIBUTING.md`](https://github.com/grafana/loki/blob/main/CONTRIBUTING.md)
guide (**required**)
- [ x ] Documentation added
- [ ] Tests updated
- [ ] `CHANGELOG.md` updated
- [ ] If the change is worth mentioning in the release notes, add
`add-to-release-notes` label
- [ ] Changes that require user attention or interaction to upgrade are
documented in `docs/sources/setup/upgrade/_index.md`
- [ ] For Helm chart changes bump the Helm chart version in
`production/helm/loki/Chart.yaml` and update
`production/helm/loki/CHANGELOG.md` and
`production/helm/loki/README.md`. [Example
PR](d10549e)
- [ ] If the change is deprecating or removing a configuration option,
update the `deprecated-config.yaml` and `deleted-config.yaml` files
respectively in the `tools/deprecated-config-checker` directory.
[Example
PR](0d4416a)

---------

Co-authored-by: J Stickler <julie.stickler@grafana.com>
(cherry picked from commit 3b2278d)
@grafanabot grafanabot requested a review from a team as a code owner January 11, 2024 16:10
@grafanabot grafanabot added backport size/M type/docs Issues related to technical documentation; the Docs Squad uses this label across many repositories labels Jan 11, 2024
helm upgrade --install loki-stack grafana/loki-stack \
--set fluent-bit.enabled=true,promtail.enabled=false
```
If you also want to host your Loki instance inside the cluster install the [official Loki helm chart](https://grafana.com/docs/loki/latest/setup/install/helm/).
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/latest/setup/install/helm/' 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 96c31d6 into release-2.9.x Jan 11, 2024
9 of 11 checks passed
@JStickler JStickler deleted the backport-11626-to-release-2.9.x branch January 11, 2024 16:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport size/M 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