Skip to content

docs: publish the scylla-3.x maintenance branch (DRIVER-1083) - #1080

Draft
nikagra wants to merge 2 commits into
scylladb:scylla-4.xfrom
nikagra:docs-publish-scylla-3x
Draft

nikagra wants to merge 2 commits into
scylladb:scylla-4.xfrom
nikagra:docs-publish-scylla-3x

Conversation

@nikagra

@nikagra nikagra commented Sep 14, 2026

Copy link
Copy Markdown

scylla-3.x is not in BRANCHES, so the newest published 3.x docs come from scylla-3.11.5.x, frozen 2025-06-02. Nothing written on the maintenance branch reaches java-driver.docs.scylladb.com, and no release will carry it there either: no tag contains the 3.x deprecation notice from #919 (scylla-3.x is 5 commits past 3.11.5.18), and no 3.x release branch has been cut since.

  • Add scylla-3.x to BRANCHES.
  • Add it to DEPRECATED_VERSIONS, so it keeps the caution banner from _templates/version-warning.html.
  • Leave it out of scylladb_markdown_recommonmark_versions — omission is what selects MyST, which its ```{eval-rst} fences need.

hide_version_dropdown in html_theme_options has listed scylla-3.x since the docs tree was ported from that branch, so this publishes without adding an entry to the version selector. That is the right outcome for a deprecated line: reachable by URL and by search, not advertised.

⚠️ Merge order. scylla-3.x is a Java 8 build (<jdk>[1.8,)</jdk>) and #1004's per-branch javadoc map defaults unknown versions to JDK 11, so scylla-3.x has to be added to its JDK 8 arm before this merges or its javadoc will fail. I've flagged it there.

Verified: make -C docs test green under -W --keep-going; sphinx-multiversion --dump-metadata lists 18 versions with scylla-3.x among them; multiversion_regex_builder(BRANCHES) matches it and DEPRECATED_VERSIONS contains it. Not covered: the full 18-version publish, which only runs post-merge.

Stacked on #1079 — its commit shows in this diff until that merges. Both wait on #1004.

Fixes DRIVER-1083

🤖 Generated with Claude Code

nikagra and others added 2 commits September 14, 2026 20:40
BRANCHES already lists every release branch that exists upstream, so no
release is left to register and /stable/ stays at scylla-4.19.0.x, frozen
four months before client routes landed.

Publish scylla-4.x and make it LATEST_VERSION, matching gocql and
cpp-driver, which both publish their development branch as stable.

/stable/ now carries upgrade_guide/from_3x/, so the deprecation banner's
migration link points straight at it, as its comment anticipated.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
scylla-3.x is not in BRANCHES, so the newest published 3.x docs come from
scylla-3.11.5.x, frozen 2025-06-02. Nothing written on the maintenance
branch reaches the site, and no tag carries it either -- the deprecation
notice from scylladb#919 has no published home.

Publish it, and mark it deprecated so it keeps the caution banner.
hide_version_dropdown already lists it, so it stays out of the version
selector: reachable by URL and search, not advertised.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Sep 14, 2026

Copy link
Copy Markdown

Important

Draft PR not reviewed

Draft PRs are not automatically reviewed by default.

  • Trigger a manual review

To automatically review draft PRs, update your CodeRabbit configuration:

reviews:
  auto_review:
    drafts: true

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.

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

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant