-
Notifications
You must be signed in to change notification settings - Fork 3.4k
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] Create top-level Setup section #9974
Conversation
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.
Should there be an alias for the old location here?
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 haven't checked every individual alias. Let me know if you would like me to double check those.
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.
afaict, the content changes are pretty small. They lgtm.
I didn't check every alias in my first pass. I've run a quick script to check that every necessary alias was added and have a few results:
|
**What this PR does / why we need it**: The changes to the helm docs in PR #9974 missed out a corresponding change needed in `docs/Makefile`. The reference.md file was also regenerated so it's up to date now. **Which issue(s) this PR fixes**: Fixes #10069 **Checklist** - [ ] 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) Signed-off-by: Michel Hollands <michel.hollands@gmail.com>
**Which issue(s) this PR fixes**: Fixes grafana#8712 **Special notes for your reviewer**: Move the following files under a new Setup section (with three subsections: Install, Migrate, and Upgrade). - ./sources/installation/sizing/index.md - ./sources/installation/_index.md - ./sources/installation/docker.md - ./sources/installation/helm/_index.md - ./sources/installation/helm/concepts.md - ./sources/installation/helm/configure-storage/index.md - ./sources/installation/helm/install-monolithic/index.md - ./sources/installation/helm/install-scalable/index.md - ./sources/installation/helm/migrate-from-distributed/index.md - ./sources/installation/helm/migrate-to-three-scalable-targets/index.md - ./sources/installation/helm/monitor-and-alert/index.md - ./sources/installation/helm/reference.md - ./sources/installation/helm/upgrade-from-2.x/index.md - ./sources/installation/install-from-source.md - ./sources/installation/istio.md - ./sources/installation/local.md - ./sources/installation/tanka.md Updates cross-references broken by the move, Updates file metadata (descriptions, weights) and adds aliases for redirects to avoid 404s. Probably fixes a couple of typos too.
Which issue(s) this PR fixes:
Fixes #8712
Special notes for your reviewer:
Move the following files under a new Setup section (with three subsections: Install, Migrate, and Upgrade).
Updates cross-references broken by the move,
Updates file metadata (descriptions, weights) and adds aliases for redirects to avoid 404s.
Probably fixes a couple of typos too.