docs(cli): fix install URL on Getting Started page#3948
Conversation
The CLI install command pointed at app.superset.sh/install.sh, which is behind auth and 307s to the sign-in page — piping that into sh fails. The installer is served from the marketing site at superset.sh/cli/install.sh (matches the in-script usage hint and the Homebrew tap path).
|
Caution Review failedPull request was closed or merged during review No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughThe CLI installation documentation has been updated to reflect a new installer URL. The installation script endpoint is now accessed from Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Review rate limit: 7/8 reviews remaining, refill in 7 minutes and 30 seconds.Comment |
Greptile SummaryThis PR fixes a broken install URL in the CLI Getting Started docs. The old URL ( Confidence Score: 5/5Safe to merge — single-line documentation fix correcting a broken install URL. The change is a one-line URL correction in a docs file with no logic, no code, and no side effects. The PR description includes manual verification that the new URL returns 200 with the correct content type and the old URL 307-redirects to sign-in. No files require special attention.
|
| Filename | Overview |
|---|---|
| apps/docs/content/docs/cli/getting-started.mdx | Single-line URL fix: app.superset.sh/install.sh → superset.sh/cli/install.sh to point to the correct installer endpoint. |
Sequence Diagram
sequenceDiagram
participant User
participant OldURL as app.superset.sh/install.sh (OLD)
participant SignIn as app.superset.sh/sign-in
participant NewURL as superset.sh/cli/install.sh (NEW)
participant sh as sh (shell)
Note over User,sh: Before fix (broken)
User->>OldURL: curl -fsSL
OldURL-->>User: 307 → /sign-in
User->>SignIn: curl follows redirect
SignIn-->>User: 200 HTML (sign-in page)
User->>sh: pipes HTML into sh
sh-->>User: silent failure / errors
Note over User,sh: After fix (correct)
User->>NewURL: curl -fsSL
NewURL-->>User: 200 install.sh (application/x-sh)
User->>sh: pipes script into sh
sh-->>User: binary installed at /usr/local/bin/superset
Reviews (1): Last reviewed commit: "docs(cli): fix install URL on Getting St..." | Re-trigger Greptile
🚀 Preview Deployment🔗 Preview Links
Preview updates automatically with new commits |
1 participant
Summary
curl -fsSL https://app.superset.sh/install.sh | sh, butapp.superset.shis the authed web app — that path 307s to/sign-in, so curl (with-L) pipes the sign-in HTML intoshand the install silently breaks.https://superset.sh/cli/install.sh(matches the script's own usage hint and the Homebrew tap published alongside it).Test plan
curl -fsSL https://superset.sh/cli/install.shreturns 200 withcontent-type: application/x-shcurl -fsSL https://app.superset.sh/install.sh307s to/sign-in?redirect=%2Finstall.sh(the broken behavior)docs.superset.sh/cli/getting-startedrenders the corrected URL after deploySummary by cubic
Fixes the CLI Getting Started install command to point to the public installer at
https://superset.sh/cli/install.sh. This avoids the auth redirect fromhttps://app.superset.sh/install.shthat piped sign-in HTML intoshand broke installs.Written for commit 83ee7a5. Summary will update on new commits.
Summary by CodeRabbit