Skip to content

Secret: drop the docs link to a private video - #7

Merged
the-human-mustachio merged 1 commit into
sst-community:mainfrom
AlperSakarya:fix/secret-docs-private-video
Oct 4, 2026
Merged

the-human-mustachio merged 1 commit into
sst-community:mainfrom
AlperSakarya:fix/secret-docs-private-video

Conversation

@AlperSakarya

@AlperSakarya AlperSakarya commented Oct 3, 2026 •

Copy link
Copy Markdown
Contributor

What this changes

Removes the "Watch a video on how secrets work" aside from two pages:

  • the Secret component page, from the doc comment in platform/src/components/secret.ts
  • the sst secret section of the CLI reference, from the command description in cmd/sst/main.go

The generated pages follow from those sources, so they aren't edited.

Why

Fixes #4 (upstream: anomalyco/sst#6975). The aside links to https://youtu.be/7tW2L3P6LKw, and YouTube shows "Video unavailable. This video is private." The link was dead on both pages, not only the one in the issue.

Closes anomalyco/sst#6975, the same report in SST's repo.

How it was tested

  • Regenerated the docs with bun run generate in www and built the site: no built page contains the video id. Before the change, the generated Secret page, the CLI reference page and cli-doc.json each had the link.
  • The Secret page still builds, without the aside.
  • bun run typecheck and go test ./cmd/... pass.

The other VideoAside links in the docs weren't checked.

The "Watch a video on how secrets work" aside linked a YouTube video
that is now private. It was in two places: the Secret component page
and the `sst secret` section of the CLI reference. Remove it from both
sources; the generated pages follow.

@the-human-mustachio the-human-mustachio left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks! Confirmed the video is private (YouTube returns 403 for it), and removing it from the doc comment and the CLI description covers both generated pages.

@the-human-mustachio
the-human-mustachio merged commit 74c2b69 into sst-community:main Oct 4, 2026
1 check passed
@AlperSakarya
AlperSakarya deleted the fix/secret-docs-private-video branch October 4, 2026 20:42
@github-actions

Copy link
Copy Markdown

Automatic review

Result ✅ No findings
Risk 🔴 high · cmd/sst/main.go
Version patch · Because it's a docs fix to two doc comments that users can't call.
Checks ✅ All 4 passed

Summary

Removes the <VideoAside> pointing at https://youtu.be/7tW2L3P6LKw, which resolves to a private YouTube video, from the two sources that generate the affected pages: the Secret component doc comment in platform/src/components/secret.ts and the sst secret command's Long description in cmd/sst/main.go. No runtime behavior, args, defaults or resources are touched; cli-doc.json and the component/CLI reference pages are generated at build time (www/.github/workflows/docs.yml:56), so nothing stale is committed. Grepping the tree confirms the video id and the "how secrets work" aside title appear nowhere else, and no other doc comment still uses VideoAside.

Release note (draft)

The Secret docs page and the sst secret CLI reference no longer link to a private video. The "Watch a video on how secrets work" aside pointed at a YouTube video that returns "Video unavailable," so it's gone from both pages.

A first pass by opencode with the free opencode/space-bunny-free model (run). It can be wrong. A committer still reviews and approves every pull request. Pushing, or editing the title or description, runs it again.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

risk: high CLI, shared platform code, release, dependencies or .github/ semver: patch

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Broken link in "Secret" documentation Broken link in "Secret" documentation

2 participants