Skip to content

docs: publish the 0.8 docs under 0.8/docs, pinned to chart 0.8.1 [ENG-1736] - #62

Merged
twk3 merged 2 commits into
release-0.8from
docs/release-0.8-docs-site
Oct 14, 2026
Merged

twk3 merged 2 commits into
release-0.8from
docs/release-0.8-docs-site

Conversation

@twk3

@twk3 twk3 commented Oct 14, 2026 •

Copy link
Copy Markdown
Contributor

Keeps the chart 0.8.x docs published at https://currents-dev.github.io/helm-charts/0.8/docs/ once main's docs describe chart 1.0 (ENG-1736).

sync-docs copies main's docs/ to gh-pages on every push. Since #59, those docs describe 1.0 values a 0.8.1 chart doesn't have: appContentStorage, and MCP and OAuth on by default. Once #61 merges they also give the new SAML ACS URL, which a 0.8.1 install answers with 404.

The branch

release-0.8 is cut from currents-0.8.1, with two main commits that apply to 0.8.1 cherry-picked onto it:

This PR targets release-0.8.

Changes

  • sync-docs.yaml on this branch deploys pushes to release-0.8 into 0.8/docs.
    • A push runs the workflow file from the pushed branch.
    • The deploy action only cleans its own target folder, so neither deploy deletes the other's files.
    • It rebases onto gh-pages (force: false) instead of force-pushing, so it can't drop a commit from main's deploy or chart-releaser that landed while it ran. A concurrency group per branch keeps this branch's own deploys in order.
    • main's deploy needs the same change: ci: rebase the docs deploy onto gh-pages instead of force-pushing [ENG-1736] #63. Merge it before or with this one.
  • Every page opens with a note: these docs are for 0.8.x, with links to the current docs and to the 1.0 upgrade guide. That guide link resolves once feat: add currents.sso.saml.allowIdpInitiated, the new SAML ACS URL and a 1.0 upgrade guide [ENG-1736] #61 merges.
  • The Helm commands pin --version 0.8.1: quickstart, IAM, upgrading and org data import. Without it they install the latest chart, which will be 1.0. upgrading.md says so.
  • Links:
    • values.yaml links point at release-0.8.
    • The Docker upgrade link points at the on-prem/2026-07-26-006 tag.
    • The CHANGELOG link stays on main, which lists every version.
  • configuration.md is regenerated from the template.

The 1.0 docs link here from the docs index and the upgrade guide (#61).

Testing

  • Pages builds .md links as .html, and /helm-charts/docs/eks/upgrading.html answers 200 today. The 1.0 guide link follows the same form.
  • configuration.md matches helm-docs.
  • The deploy itself runs on merge. After it, https://currents-dev.github.io/helm-charts/0.8/docs/ should serve, and /helm-charts/docs/ should be unchanged.

🤖 Generated with Claude Code

https://claude.ai/code/session_01UhM4wHR2xPP8bbrkXGaqUD

…-1736]

main's docs describe chart 1.0 once the SAML ACS change merges (and
already describe its app content bucket, MCP and OAuth values), so a
0.8.1 operator reading them would set up SSO against a URL their install
answers with 404. This branch keeps the 0.8.1 docs, plus the RustFS and
scheduler restart fixes that apply to it, at
https://currents-dev.github.io/helm-charts/0.8/docs/.

- sync-docs deploys this branch to 0.8/docs. The action only cleans its
  target folder, so main's docs/ deploy leaves it alone and vice versa.
- Every page says it is for 0.8.x and links the current docs and the 1.0
  upgrade guide.
- Helm commands pin --version 0.8.1: without it they install the latest
  chart. values.yaml links point at this branch; the Docker upgrade link
  at on-prem/2026-07-26-006.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01UhM4wHR2xPP8bbrkXGaqUD
@baz-reviewer

baz-reviewer Bot commented Oct 14, 2026 •

Copy link
Copy Markdown

Review this PR on Baz

Baz Summary

Publish the chart 0.8.x documentation under 0.8/docs while preserving the current documentation site. Pin Helm commands and references to chart 0.8.1, and mark the legacy docs with upgrade guidance so users do not install incompatible 1.0 releases.

Topics

TopicDetails
Versioned Docs Publishing Publish the release-0.8 documentation to the isolated 0.8/docs GitHub Pages path, retaining the main docs and other gh-pages content through non-forced deployment and branch-specific concurrency.
Modified files (1)
  • .github/workflows/sync-docs.yaml
Latest Contributors(1)
UserCommitDate
dj@currents.devci: rebase the 0.8 doc...October 14, 2026
Versioned 0.8 Docs Version the Helm usage instructions and configuration references for chart 0.8.1, while adding consistent 0.8.x notices and links to the current documentation and 1.0 upgrade guide.
Modified files (11)
  • docs/README.md
  • docs/configuration.md
  • docs/configuration.md.gotmpl
  • docs/developer-guide/README.md
  • docs/eks/README.md
  • docs/eks/dependencies.md
  • docs/eks/iam.md
  • docs/eks/quickstart.md
  • docs/eks/upgrading.md
  • docs/org-data-import.md
  • docs/support.md
Latest Contributors(2)
UserCommitDate
dj@currents.devdocs: publish the 0.8 ...October 14, 2026
agoldis@users.noreply....Update README.mdJune 04, 2025

Merger  Activate to get a short verdict whether this PR is good to go or not

Skills  Activate Skill Maintainer to keep your skills up to date

Planner  This PR would have been improved with Baz Planner - Try it now

Comment thread .github/workflows/sync-docs.yaml Outdated
… [ENG-1736]

The deploy action force-pushes by default. main's docs deploy and
chart-releaser also push to gh-pages, so whichever push lands last from
an older checkout would drop the others' commits, and the comment saying
the two deploys never overwrite each other was wrong. A concurrency group
per branch keeps this branch's own deploys in order.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01UhM4wHR2xPP8bbrkXGaqUD
@twk3
twk3 merged commit 24b4cb7 into release-0.8 Oct 14, 2026
3 checks passed
@twk3
twk3 deleted the docs/release-0.8-docs-site branch October 14, 2026 19:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant