-
Notifications
You must be signed in to change notification settings - Fork 544
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
Docs: Move configuration information to top level, and rename section to Configure. #4481
Docs: Move configuration information to top level, and rename section to Configure. #4481
Conversation
@jdbaldry, When I was doing this manually, I saw that link after link the build got better so I thought I was making progress. However, the doc validator seems to have me changing them again, fortunately in much less time. However, I am not sure why the local build keep improving when I fixed all these links manually. |
CHANGELOG.md
Outdated
@@ -343,7 +343,7 @@ Querying with using `{__mimir_storage__="ephemeral"}` selector no longer works. | |||
### Jsonnet | |||
|
|||
* [CHANGE] Replaced the deprecated `policy/v1beta1` with `policy/v1` when configuring a PodDisruptionBudget. #3284 | |||
* [CHANGE] [Common storage configuration](https://grafana.com/docs/mimir/v2.3.x/operators-guide/configure/configure-object-storage-backend/#common-configuration) is now used to configure object storage in all components. This is a breaking change in terms of Jsonnet manifests and also a CLI flag update for components that use object storage, so it will require a rollout of those components. The changes include: #3257 | |||
* [CHANGE] [Common storage configuration](https://grafana.com/docs/mimir/v2.3.x/configure/configure-object-storage-backend/#common-configuration) is now used to configure object storage in all components. This is a breaking change in terms of Jsonnet manifests and also a CLI flag update for components that use object storage, so it will require a rollout of those components. The changes include: #3257 |
This comment was marked as resolved.
This comment was marked as resolved.
Sorry, something went wrong.
CHANGELOG.md
Outdated
@@ -356,7 +356,7 @@ Querying with using `{__mimir_storage__="ephemeral"}` selector no longer works. | |||
* Renaming `blocks_storage_backend` key to `storage_backend`. | |||
* For Azure/S3: | |||
* Renaming `blocks_storage_(azure|s3)_*` configurations to `storage_(azure|s3)_*`. | |||
* If `ruler_storage_(azure|s3)_*` and `alertmanager_storage_(azure|s3)_*` keys were different from the `block_storage_*` ones, they should be now provided using CLI flags, see [configuration reference](https://grafana.com/docs/mimir/v2.3.x/operators-guide/configure/reference-configuration-parameters/) for more details. | |||
* If `ruler_storage_(azure|s3)_*` and `alertmanager_storage_(azure|s3)_*` keys were different from the `block_storage_*` ones, they should be now provided using CLI flags, see [configuration reference](https://grafana.com/docs/mimir/v2.3.x/configure/reference-configuration-parameters/) for more details. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Same thing here. Will come back to this to revert it.
@@ -7,7 +7,7 @@ weight: 10 | |||
|
|||
# Migrate from single zone to zone-aware replication | |||
|
|||
This document explains how to migrate stateful components from single zone to [zone-aware replication](/docs/mimir/v2.6.x/operators-guide/configure/configure-zone-aware-replication/) with Helm. The three components in question are the [alertmanager](/docs/mimir/v2.6.x/operators-guide/architecture/components/alertmanager/), the [store-gateway](/docs/mimir/v2.6.x/operators-guide/architecture/components/store-gateway/) and the [ingester](/docs/mimir/v2.6.x/operators-guide/architecture/components/ingester/). | |||
This document explains how to migrate stateful components from single zone to [zone-aware replication](/docs/mimir/v2.6.x/configure/configure-zone-aware-replication/) with Helm. The three components in question are the [alertmanager](/docs/mimir/v2.6.x/operators-guide/architecture/components/alertmanager/), the [store-gateway](/docs/mimir/v2.6.x/operators-guide/architecture/components/store-gateway/) and the [ingester](/docs/mimir/v2.6.x/operators-guide/architecture/components/ingester/). |
This comment was marked as off-topic.
This comment was marked as off-topic.
Sorry, something went wrong.
This comment was marked as off-topic.
This comment was marked as off-topic.
Sorry, something went wrong.
It might have do with my git commit. Will take a look tomorrow on a fresh brain. |
@krajorama and I will handle changes to Helm chart documentation versions in a subsequent PR, likely today. |
Ambiguous relref resolution can make the Hugo build improve but For example, the relref
I am going to work on an improvement to |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I see no errors when a website build with:
$ $ ~/ext/grafana/technical-documentation/scripts/make-docs oncall incident mimir:v2.7.x grafana:v9.4:grafana:v9.4.x/docs/sources grafana-cloud "arbitrary:${HOME}/ext/grafana/website/scripts/docs/versions.js:/hugo/scripts/docs/versions.js" "arbitrary:${HOME}/ext/grafana/website/layouts/shortcodes/docs:/hugo/layouts/shortcodes/docs"
NOTE Serving '/home/jdb/ext/grafana/oncall/docs/sources' (branch 'main') at URL http://localhost:3002/docs/oncall/latest/
NOTE Serving '/home/jdb/ext/grafana/incident/docs/sources' (branch 'main') at URL http://localhost:3002/docs/incident/latest/
NOTE Serving '/home/jdb/ext/grafana/mimir/docs/sources/mimir' (branch 'osg-grafana/2023-03-13-move-configure-topics-to-top-level-of-toc') at URL http://localhost:3002/docs/mimir/v2.7.x/
NOTE Serving '/home/jdb/ext/grafana/grafana/v9.4.x/docs/sources' (branch 'jdb/2023-03-fix-website-build-errors-v9.4.x') at URL http://localhost:3002/docs/grafana/v9.4/
NOTE Serving '/home/jdb/ext/grafana/cloud-docs/docs/sources' (branch 'jdb/2023-03-fix-doc-validator') at URL http://localhost:3002/docs/grafana-cloud/
NOTE Mounting '/home/jdb/ext/grafana/website/scripts/docs/versions.js' at '/hugo/scripts/docs/versions.js'
NOTE Mounting '/home/jdb/ext/grafana/website/layouts/shortcodes/docs' at '/hugo/layouts/shortcodes/docs'
grafana -> v9.4
mimir -> v2.7.x
content/docs/grafana/v9.4/tutorials/build-a-data-source-backend-plugin -> content/tutorials/build-a-data-source-backend-plugin
content/docs/grafana/v9.4/tutorials/build-a-data-source-plugin -> content/tutorials/build-a-data-source-plugin
content/docs/grafana/v9.4/tutorials/build-an-app-plugin -> content/tutorials/build-an-app-plugin
content/docs/grafana/v9.4/tutorials/build-a-panel-plugin -> content/tutorials/build-a-panel-plugin
content/docs/grafana/v9.4/tutorials/build-a-panel-plugin-with-d3 -> content/tutorials/build-a-panel-plugin-with-d3
content/docs/grafana/v9.4/tutorials/build-a-streaming-data-source-plugin -> content/tutorials/build-a-streaming-data-source-plugin
content/docs/grafana/v9.4/tutorials/create-alerts-from-flux-queries -> content/tutorials/create-alerts-from-flux-queries
content/docs/grafana/v9.4/tutorials/create-users-and-teams -> content/tutorials/create-users-and-teams
content/docs/grafana/v9.4/tutorials/grafana-fundamentals -> content/tutorials/grafana-fundamentals
content/docs/grafana/v9.4/tutorials/iis -> content/tutorials/iis
content/docs/grafana/v9.4/tutorials/install-grafana-on-raspberry-pi -> content/tutorials/install-grafana-on-raspberry-pi
content/docs/grafana/v9.4/tutorials/integrate-hubot -> content/tutorials/integrate-hubot
content/docs/grafana/v9.4/tutorials/provision-dashboards-and-data-sources -> content/tutorials/provision-dashboards-and-data-sources
content/docs/grafana/v9.4/tutorials/run-grafana-behind-a-proxy -> content/tutorials/run-grafana-behind-a-proxy
content/docs/grafana/v9.4/tutorials/stream-metrics-from-telegraf-to-grafana -> content/tutorials/stream-metrics-from-telegraf-to-grafana
content/docs/grafana-cloud/tutorials/grafana-fundamentals-cloud -> content/tutorials/grafana-fundamentals-cloud
content/docs/grafana-cloud/tutorials/k8s-monitoring-app -> content/tutorials/k8s-monitoring-app
content/docs/mimir/v2.7.x/tutorials/play-with-grafana-mimir -> content/tutorials/play-with-grafana-mimir
content/docs/grafana/v9.4/alerting -> content/docs/grafana-cloud/alerting
content/docs/grafana/v9.4/developers/http_api -> content/docs/grafana-cloud/api-reference/http-api
content/docs/incident/latest -> content/docs/grafana-cloud/incident
hugo server -p 3003 --buildDrafts=false --buildFuture=false --bind 0.0.0.0 --noHTTPCache --minify --poll 700ms --renderToDisk -d dist --baseURL http://localhost:3002/ --appendPort=false
Start building sites …
hugo v0.101.0-466fa43c16709b4483689930a4f9ac8add5c9f66+extended linux/amd64 BuildDate=2022-06-16T07:09:16Z VendorInfo=gohugoio
| EN | DE | FR | ES | PT-BR
-------------------+------+------+------+------+--------
Pages | 2583 | 11 | 11 | 11 | 11
Paginator pages | 0 | 0 | 0 | 0 | 0
Non-page files | 141 | 0 | 0 | 0 | 0
Static files | 1192 | 1192 | 1192 | 1192 | 1192
Processed images | 0 | 0 | 0 | 0 | 0
Aliases | 3220 | 0 | 0 | 0 | 0
Sitemaps | 2 | 1 | 1 | 1 | 1
Cleaned | 0 | 0 | 0 | 0 | 0
Built in 2407 ms
Watching for changes in /hugo/{content,data,i18n,layouts,package.json,static}
Use watcher with poll interval 700ms
Watching for config changes in /hugo/config/_default, /hugo/config/docs
Environment: "docs"
Serving pages from /hugo/dist
Running in Fast Render Mode. For full rebuilds on change: hugo server --disableFastRender
Web Server is available at http://localhost:3002/ (bind address 0.0.0.0)
Press Ctrl+C to stop
Excellent. I am happy to review and test your solution, and thank you! :) |
I am about to commit changes to the aliases before squashing and merging. |
The aliases worked locally, and I tested them one-by-one. |
No description provided.