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

[Docs] Create top-level Setup section #9974

Merged
merged 8 commits into from
Jul 21, 2023
Merged

Conversation

JStickler
Copy link
Contributor

@JStickler JStickler commented Jul 18, 2023

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).

  • ./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.

@JStickler JStickler requested a review from a team as a code owner July 18, 2023 20:49
@github-actions github-actions bot added area/helm type/docs Issues related to technical documentation; the Docs Squad uses this label across many repositories labels Jul 18, 2023
@JStickler JStickler changed the title Loki 8712 [Docs] Create top-level Setup section Jul 18, 2023
Copy link
Member

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?

Copy link
Member

@jdbaldry jdbaldry left a 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.

docs/sources/setup/migrate/_index.md Outdated Show resolved Hide resolved
docs/sources/setup/migrate/_index.md Outdated Show resolved Hide resolved
docs/sources/operations/storage/wal.md Outdated Show resolved Hide resolved
docs/sources/release-notes/v2-3.md Outdated Show resolved Hide resolved
docs/sources/setup/install/helm/_index.md Show resolved Hide resolved
docs/sources/setup/install/helm/concepts.md Outdated Show resolved Hide resolved
docs/sources/setup/install/local.md Outdated Show resolved Hide resolved
Copy link
Contributor

@MasslessParticle MasslessParticle left a 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.

@jdbaldry
Copy link
Member

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:

$ SKIP_EXISTING=true ~/bin/add-aliases 
Steps:

1. Update `docs/sources/setup/install/helm/monitor-and-alert/with-grafana-cloud.md` with:
../../../../installation/helm/monitor-and-alert/with-grafana-cloud/
2. Test by going to:
http://localhost:3002/docs/loki/latest/installation/helm/monitor-and-alert/with-grafana-cloud/
3. You should be redirected to:
http://localhost:3002/docs/loki/latest/setup/install/helm/monitor-and-alert/with-grafana-cloud/

1. Update `docs/sources/setup/migrate/migrate-from-distributed/index.md` with:
../../installation/helm/migrate-from-distributed/
2. Test by going to:
http://localhost:3002/docs/loki/latest/installation/helm/migrate-from-distributed/
3. You should be redirected to:
http://localhost:3002/docs/loki/latest/setup/migrate/migrate-from-distributed/

1. Update `docs/sources/setup/upgrade/upgrade-from-2x/index.md` with:
../../installation/helm/upgrade-from-2.x/
2. Test by going to:
http://localhost:3002/docs/loki/latest/installation/helm/upgrade-from-2.x/
3. You should be redirected to:
http://localhost:3002/docs/loki/latest/setup/upgrade/upgrade-from-2x/

@JStickler JStickler merged commit aae92b9 into grafana:main Jul 21, 2023
4 checks passed
MichelHollands added a commit that referenced this pull request Jul 26, 2023
**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>
JStickler added a commit that referenced this pull request Aug 7, 2023
**Which issue(s) this PR fixes**:
Fixes #10105  by rolling back the README changes from #9974.
@JStickler JStickler deleted the Loki_8712 branch September 7, 2023 13:47
mraboosk pushed a commit to mraboosk/loki that referenced this pull request Oct 7, 2024
**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.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/helm size/L 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.

[Docs] Create top-level Set up section
4 participants