Skip to content

docs(environment-setup): accuracy + copy/structure (no #192 dependency)#48

Merged
LukasWodka merged 1 commit into
developfrom
docs/env-setup-accuracy
Jun 4, 2026
Merged

docs(environment-setup): accuracy + copy/structure (no #192 dependency)#48
LukasWodka merged 1 commit into
developfrom
docs/env-setup-accuracy

Conversation

@LukasWodka
Copy link
Copy Markdown
Contributor

The #192-independent half of the Environment Setup audit, split out of #47 — correct against the current installer, safe to merge and promote now.

Accuracy

  • Firewall domains (setup-guide): replaced the misleading github.com with what the installer actually hits — ghcr.io (ingestor image), raw.githubusercontent.com (install scripts), *.github.io (Helm chart repo). The old list breaks installs behind a strict firewall.
  • Phantom config (configuration): removed HTTP_PORT/HTTPS_PORT — the installer disables ingress (traefik/servicelb) and binds only the API port.
  • --diagnose (troubleshooting): documented the redacted support bundle (was missing).

Copy + structure

  • EKS: added a "when to use EKS vs the local installer" callout + a back-link to Setup Guide (the section had no fork), plus a Quick-vs-Detailed signpost; dropped softeners ("Treat this as a solid baseline", "about 1–2 hours") and tightened verbose lines.
  • Configuration: an installer-vs-manual-Helm audience signpost; tightened the GPU / "Platform behaviour" / auto-upgrade lines.

The namespace/workspace edits (which describe client#192) stay in #47, held to merge with #192.

Validated: MDX components balanced, docs.json valid. Targets develop.

Independent of the installer namespace change (client#192) -- safe to ship now.

Accuracy:
- Firewall domains: drop the misleading `github.com`; add ghcr.io (ingestor),
  raw.githubusercontent.com (scripts), *.github.io (chart repo).
- Drop the phantom HTTP_PORT/HTTPS_PORT knobs (installer disables ingress).
- Troubleshooting: document the `--diagnose` support bundle.

Copy + structure:
- EKS: "when to use EKS vs local" callout + back-link to setup-guide;
  Quick-vs-Detailed signpost; dropped softeners/verbosity.
- Configuration: installer-vs-Helm audience signpost; tightened verbose lines.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@LukasWodka
Copy link
Copy Markdown
Contributor Author

👋 Heads-up — Code review queue is at 14 / 8

Above the WIP limit. The team convention is to review existing PRs before opening new work.

Open PRs currently in Code review (oldest first):

Pull from review before opening new work. (This is a nudge from the kanban WIP check, not a block.)

@LukasWodka LukasWodka merged commit 7477768 into develop Jun 4, 2026
4 checks passed
@LukasWodka LukasWodka deleted the docs/env-setup-accuracy branch June 4, 2026 08:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants