Add References section. #4276
Merged
Add References section. #4276
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
osg-grafana
commented
Feb 22, 2023
...elm-charts/mimir-distributed/run-production-environment-with-helm/configuration-with-helm.md
Outdated
Show resolved
Hide resolved
…ronment-with-helm/configuration-with-helm.md
osg-grafana
commented
Feb 22, 2023
| @@ -0,0 +1,20 @@ | |||
| --- | |||
| title: "Grafana Mimir references" | |||
There was a problem hiding this comment.
@knylander-grafana, I could use your input about how we can standardize the _index.md file for references across the DB docs. Have thoughts on this?
There was a problem hiding this comment.
Consider these topics:
- Introduction - section purpose with high-level description, philosophy of how things are organized (if applicable)
- Info of any major groupings of references, like developer content, configuration, architecture, etc.
After that, have your list of {{<section>}}
|
@pracucci, added you for visibility. |
Co-authored-by: Felix Beuke <[email protected]>
pracucci
approved these changes
Feb 23, 2023
| @@ -10,7 +10,7 @@ aliases: | |||
|
|
|||
| # Manage the configuration of Grafana Mimir with Helm | |||
|
|
|||
| The `mimir-distributed` Helm chart provides interfaces to set Grafana Mimir [configuration parameters](/docs/mimir/v2.5.x/operators-guide/configure/reference-configuration-parameters/) and customize how Grafana Mimir is deployed on a Kubernetes cluster. This document describes the configuration parameters. | |||
| The `mimir-distributed` Helm chart provides interfaces to set Grafana Mimir [configuration parameters](/docs/mimir/v2.5.x/operators-guide/configure/references-configuration-parameters/) and customize how Grafana Mimir is deployed on a Kubernetes cluster. This document describes the configuration parameters. | |||
There was a problem hiding this comment.
Shouldn't be like this?
Suggested change
| The `mimir-distributed` Helm chart provides interfaces to set Grafana Mimir [configuration parameters](/docs/mimir/v2.5.x/operators-guide/configure/references-configuration-parameters/) and customize how Grafana Mimir is deployed on a Kubernetes cluster. This document describes the configuration parameters. | |
| The `mimir-distributed` Helm chart provides interfaces to set Grafana Mimir [configuration parameters](/docs/mimir/v2.5.x/operators-guide/configure/references/configuration-parameters/) and customize how Grafana Mimir is deployed on a Kubernetes cluster. This document describes the configuration parameters. |
There was a problem hiding this comment.
I do not think so because it is a static link to a specific release. @krajorama, this is what we decided, right?
There was a problem hiding this comment.
Yes, we've decided to link the correct Mimir/GEM documentation from the Helm chart docs. Which means the version that the chart actually contains. Hopefully this will be done with some version variable that we can set in one place sometime in the not so distant future.
Given this, the v2.5.x documentation is in the right place already, no need to change in this PR I think.
osg-grafana
deleted the
4275-docs-create-a-top-level-references-section
branch
krajorama
added a commit
that referenced
this pull request
Mar 14, 2023
Fix configuration parameter reference link. Ref: #4276 Update link to HA dedup setup with Consul to be a relref, since it was moved into the Helm docs. Ref: #4338 Signed-off-by: György Krajcsovits <[email protected]>
1 task
krajorama
added a commit
that referenced
this pull request
Mar 14, 2023
Fix configuration parameter reference link. Ref: #4276 Update link to HA dedup setup with Consul to be a relref, since it was moved into the Helm docs. Ref: #4338 Signed-off-by: György Krajcsovits <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.