CrateDB 3.x: Documentation for 3.3 turned off, so refer to sources instead. Also tune down other content.

[amotl]

About

We turned off CrateDB 3.3 docs recently.

Preview

• https://cratedb-guide--359.org.readthedocs.build/admin/clustering/multi-node-setup.html#seeding-manually
• https://cratedb-guide--359.org.readthedocs.build/admin/clustering/scale/kubernetes.html
• https://cratedb-guide--359.org.readthedocs.build/install/cloud/aws/ec2-setup.html#basic-configuration
• https://cratedb-guide--359.org.readthedocs.build/install/cloud/azure/vm.html#configure-cratedb

[coderabbitai]

Walkthrough

This PR updates documentation links and guidance: it rehomes several clustering-related anchors into a new CrateDB 3.x section, repoints multiple cross-references from cratedb.com to GitHub blob URLs, adjusts Kubernetes recovery/scaling notes, and removes the CrateDB 3.3 URL from Sphinx's linkcheck_ignore.

Changes

Cohort / File(s)	Summary
Clustering docs (multi-node & Kubernetes) docs/admin/clustering/multi-node-setup.md, docs/admin/clustering/scale/kubernetes.md	Reorganized quorum-related content into a CrateDB 3.x section, converted inline anchor/link syntax to bracketed links, updated targets to GitHub blob/reference URLs, added Kubernetes recovery/quorum guidance and adjusted cross-references; preserved original semantics.
Cloud install docs (AWS & Azure) docs/install/cloud/aws/ec2-setup.rst, docs/install/cloud/azure/vm.rst	Repointed CrateDB 3.3 discovery anchors to GitHub blob URLs, standardized/fixed external AWS links (IAM/signing and EC2 IAM roles), and updated latest-site targets to canonical cratedb.com paths.
Sphinx linkcheck configuration docs/conf.py	Removed the CrateDB 3.3 docs URL from linkcheck_ignore so the URL will now be validated by Sphinx linkcheck.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

• LlamaIndex: Refactor Text-to-SQL synopsis. Add full tutorial. #316: Also modifies docs/conf.py linkcheck_ignore entries and touches the same configuration area.
• Chore: Fix broken links 20250929 #343: Adjusts docs/conf.py linkcheck_ignore handling for the CrateDB 3.3 URL and is directly related.

Suggested reviewers

• kneth
• bmunkholm

Poem

I hop through docs with nimble paws,
I stitch the links and mend the flaws.
I move old anchors to a GitHub tree,
Wake linkcheck up so checks run free.
Carrots for commits — a joyful spree! 🥕🐇

Pre-merge checks and finishing touches

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Title Check	❓ Inconclusive	The title is too long and split into two sentences instead of a single concise summary of the primary change. It uses a vague phrase “tune down other content” that does not clearly describe what was updated beyond disabling CrateDB 3.3 documentation. While it mentions turning off 3.3 docs, the overall phrasing is broad and does not succinctly convey the most important update. Therefore it is too generic to conclusively summarize the changes.	Consider revising the title to a single clear sentence focused on disabling CrateDB 3.3 documentation and updating its related links, avoiding vague or multiple clauses.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	The description explains that the CrateDB 3.3 documentation was turned off and provides preview links to the affected pages, directly reflecting the changes in this pull request. It is clearly related to the modifications made in the documentation and therefore satisfies the lenient criteria for passing this check.
Docstring Coverage	✅ Passed	No functions found in the changes. Docstring coverage check skipped.

✨ Finishing touches

• 📝 Generate docstrings

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch rm-cratedb-3.3

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 8d5ddb8 and c4e0219.

📒 Files selected for processing (5)

• docs/admin/clustering/multi-node-setup.md (2 hunks)
• docs/admin/clustering/scale/kubernetes.md (4 hunks)
• docs/conf.py (0 hunks)
• docs/install/cloud/aws/ec2-setup.rst (1 hunks)
• docs/install/cloud/azure/vm.rst (1 hunks)

💤 Files with no reviewable changes (1)

• docs/conf.py

🚧 Files skipped from review as they are similar to previous changes (2)

• docs/install/cloud/azure/vm.rst
• docs/admin/clustering/multi-node-setup.md

🧰 Additional context used

🧠 Learnings (1)

📓 Common learnings

Learnt from: bmunkholm
PR: crate/cratedb-guide#340
File: docs/home/index.md:84-97
Timestamp: 2025-09-25T19:31:54.320Z
Learning: In the CrateDB Guide docs (MyST), the CrateDB Cloud card on the homepage should link to `getting-started` using `:link-type: ref` instead of the previous `cloud:index` intersphinx target. This change was implemented in PR #340 to direct users to the getting started section rather than directly to the Cloud documentation.

Learnt from: amotl
PR: crate/cratedb-guide#236
File: docs/index.md:312-316
Timestamp: 2025-08-09T11:00:03.578Z
Learning: In the CrateDB Guide documentation, locally stale references (such as `(reference-architectures)=`, `(domain)=`, and similar anchor labels) should be retained even when they appear unused within the repository, as external projects might still reference them. This ensures backward compatibility for external documentation and projects.

Learnt from: amotl
PR: crate/cratedb-guide#235
File: docs/start/going-further.md:20-38
Timestamp: 2025-08-23T04:22:52.597Z
Learning: In the CrateDB Guide repository, the prefix `crate-reference:` in documentation links (like `crate-reference:index`) is an intersphinx reference that points to external content in the CrateDB Reference Manual documentation. These references are intentionally not pointing to local files within the repository.

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

• GitHub Check: Build docs

---

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

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[matriv]

Thx! But maybe consider removing any reference to 3.x now that we have moved on?

[amotl]

Maybe consider removing any reference to 3.x now that we have moved on?

It was actually meant to be a reference for people who are still running CrateDB 3.x. Don't you think it is a good idea? Sure enough, in order to simplify presentation, we could de-inline all docs relevant for CrateDB 3.x, but bundle them into relevant "Appendix" sections instead. wdyt?

[matriv]

Maybe consider removing any reference to 3.x now that we have moved on?

It was actually meant to be a reference for people who are still running CrateDB 3.x. Don't you think it is a good idea? Sure enough, in order to simplify presentation, we could de-inline all docs relevant for CrateDB 3.x, but bundle them into relevant "Appendix" sections instead. wdyt?

No strong opinion, just an idea, since we're now 3 major versions ahead of that.

[amotl]

c4e0219 further tunes down content about CrateDB 3.x, without removing it just yet. You can review the changes here:

• https://cratedb-guide--359.org.readthedocs.build/admin/clustering/multi-node-setup.html#cratedb-3-x
• https://cratedb-guide--359.org.readthedocs.build/admin/clustering/scale/kubernetes.html#clustering-behavior

[matriv]

thx!