Skip to content

Docs: Document the installer at www.rossoctl.dev - #1397

Merged
esnible merged 1 commit into
rossoctl:mainfrom
esnible:docs/install-url
Oct 14, 2026
Merged

esnible merged 1 commit into
rossoctl:mainfrom
esnible:docs/install-url

Conversation

@esnible

@esnible esnible commented Oct 14, 2026 •

Copy link
Copy Markdown
Member

Follow-up to #1354. rossoctl/.github#130 now serves scripts/install.sh at https://www.rossoctl.dev/cortex/install.sh (synced from main on every site deploy), so this makes it the documented one-liner.

Moved to the www URL

  • scripts/install.sh: the header comment and --help
  • README.md: Quick start
  • CONTRIBUTING.md: the release-candidate example (--ref=v0.9.0-rc.1)
  • cmd/agentop/setup_step_binaries.go: installerOneLiner, the fix agentop setup/doctor print when nothing is installed. This also drops the old authbridge/install.sh path, which only worked through the v0.7.0 redirect script.
  • .github/workflows/release-binaries.yaml: the install lines in the prerelease and main-latest release notes
  • scripts/readme-demo/demo.yaml, plus docs/assets/cortex-demo.svg regenerated from it with go run .

Kept on raw.githubusercontent.com: the repo should not depend on the site being current.

  • README.md names it once, as the alternate if rossoctl.dev is unreachable.
  • install.sh's re-exec fetches, which --ref pinning and the legacy-path fallbacks rely on, and its no-setup recovery hint. install_test.sh is unchanged.
  • CONTRIBUTING.md's "Installing an unreleased build" (--ref=main) example. --ref=main runs the piped copy itself rather than re-execing, so piped from the site it would run the site's copy, which can lag main.

The website's laptop quickstart (rossoctl/rossoctl, docs/get-started/laptop.md) will be updated separately.

Testing

  • sh scripts/install_test.sh: 239 passed, 0 failed
  • cmd/agentop: go vet ./... and go test ./... pass
  • scripts/readme-demo: go test ./... passes, including the staleness check against demo.yaml

Assisted-By: Claude (Anthropic AI) noreply@anthropic.com

Summary by CodeRabbit

  • Documentation
    • Updated installation instructions and examples to download the installer from rossoctl.dev.
    • Added a GitHub-hosted installer fallback to the Quick start instructions.

rossoctl/.github#130 serves scripts/install.sh at
https://www.rossoctl.dev/cortex/install.sh, synced from main on every site
deploy. Make that the documented one-liner: install.sh's header and
--help, the README quick start, CONTRIBUTING's release-candidate example,
agentop's "nothing is installed" fix, the release notes, and the README
animation (regenerated from demo.yaml).

The raw.githubusercontent.com URL stays in the README as the one alternate,
and wherever the repo must not depend on the site being current:
install.sh's own re-exec fetches and its no-setup recovery hint, and
CONTRIBUTING's --ref=main example, which runs the piped copy itself and
so would run the site's possibly day-old one.

agentop's one-liner also stops naming authbridge/install.sh, which only
worked through the v0.7.0 redirect script.

Refs rossoctl#1354

Assisted-By: Claude (Anthropic AI) <noreply@anthropic.com>
Signed-off-by: Ed Snible <snible@us.ibm.com>
@coderabbitai

coderabbitai Bot commented Oct 14, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration
  • Configuration used: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: cf9d022c-f341-4b50-939f-821fdf451cd7
📥 Commits

Reviewing files that changed from the base of the PR and between 9fb96e6 and 07a5930.

⛔ Files ignored due to path filters: 1
  • docs/assets/cortex-demo.svg is excluded by !**/*.svg
📒 Files selected for processing: 6
  • .github/workflows/release-binaries.yaml
  • CONTRIBUTING.md
  • README.md
  • cmd/agentop/setup_step_binaries.go
  • scripts/install.sh
  • scripts/readme-demo/demo.yaml

Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review.

📝 Walkthrough

Installer commands and release instructions now fetch install.sh from www.rossoctl.dev/cortex. The README also documents a repository-hosted fallback.

Changes: Installer URL references

Layer / File(s) Summary
Switch installer references to the website
cmd/agentop/setup_step_binaries.go, scripts/install.sh, .github/workflows/release-binaries.yaml, README.md, CONTRIBUTING.md, scripts/readme-demo/demo.yaml
Installer commands, script examples, and release instructions use the website URL instead of GitHub raw-content URLs. The README adds a repository-hosted fallback.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~4 minutes

Change: Other

Merge Risk: ⚪ Minimal · up to 07a59

Installer instructions now use the site-hosted script. Although that copy may lag until the next site deployment, the documented rolling-channel path still selects the main-latest binaries; no concrete install failure is established, so the change is ready for normal checks.

Pre-merge checks: Passed 5
Passed Passed checks: 5 passed
Check name Status Explanation
Description Check Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check Passed The title clearly identifies the primary change: documenting the installer at www.rossoctl.dev. It is concise, specific, and related to the updated installation instructions.
Docstring Coverage Passed Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 1 functions across 2 files. (4 skipped: 4 …
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@mrsabath mrsabath left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Mechanical URL swap across 7 files, backed by infrastructure that is already merged and verifiably live. The interesting work here is the restraint: every retained raw.githubusercontent.com reference has a specific reason tied to the site's resync cadence, and I checked each one against the actual code path rather than taking the description's word for it.

What I verified

Claim Result
www.rossoctl.dev/cortex/install.sh is live 200, application/x-sh, 64952 bytes — byte-identical to pre-PR scripts/install.sh
rossoctl/.github#130 serves it Merged, Docusaurus postBuild plugin copies cortex/ to build/cortex/
Sync cadence justifies the kept raw URLs Deploy triggers are push-to-site, docs-updated dispatch from rossoctl/rossoctl, and a daily 06:17 UTC cron — nothing fires from rossoctl/cortex, so the site can lag main by up to ~24h
--ref=main correctly kept on raw (CONTRIBUTING.md:116) That path short-circuits the re-exec (install.sh:438-445) and runs the piped copy itself — from the site it would run a possibly day-old script
--ref=v0.9.0-rc.1 safely moved to www (CONTRIBUTING.md:218) Re-execs into the pinned ref from raw, so the entry point is irrelevant
Re-exec and legacy fallbacks untouched All three probe URLs (scripts/, root, authbridge/) still raw; install_test.sh unchanged
authbridge/install.sh drop in setup_step_binaries.go That path only resolved via the v0.7.0 redirect; the re-exec still probes it as a legacy fallback, so nothing regresses
SVG is a genuine regen, not hand-edited All 76 changed lines are CSS keyframe timing (91 to 60 steps, 764.4px to 504.0px — consistent with the shorter URL) plus the rendered text; zero raw.githubusercontent left in it
No missed references release-binaries.yaml fully converted. scripts/release_smoke_test_linux.sh correctly left on raw — it pins TRIGGER_SHA, which only raw can serve, and CI must test the repo's own copy

The --ref=main-vs---ref=<tag> asymmetry in CONTRIBUTING.md looks inconsistent at a glance but is precisely correct given that only the former bypasses the re-exec. The README fallback note is a good addition — it keeps the repo self-sufficient when the site is unreachable, which is the same instinct driving the retained raw URLs.

Follow-up already flagged in the description, noted here so it is not lost: rossoctl/rossoctl docs/get-started/laptop.md:30 still has the raw URL, and the comment at README.md:19-21 exists precisely because these two drift.

Areas reviewed: Shell, Go, YAML, Docs, CI workflows, generated SVG
Commits: 1, signed-off: yes
CI status: passing (28/28; Spellcheck skipped by path filter)

Verified against 07a5930 throughout. LGTM.

@esnible
esnible merged commit cc4e6be into rossoctl:main Oct 14, 2026
30 checks passed
@esnible
esnible deleted the docs/install-url branch October 14, 2026 17:47
@github-project-automation github-project-automation Bot moved this from New/ToDo to Done in Rossoctl Issue Prioritization Oct 14, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

3 participants