Skip to content

installation link fixed#893

Open
Bonusree wants to merge 1 commit into
masterfrom
link-fix
Open

installation link fixed#893
Bonusree wants to merge 1 commit into
masterfrom
link-fix

Conversation

@Bonusree

@Bonusree Bonusree commented Jun 18, 2026

Copy link
Copy Markdown
Contributor

Summary by CodeRabbit

  • Documentation
    • Updated installation documentation links across backup and restore guides for multiple databases. KubeStash and KubeDB setup references now point to the general setup pages, streamlining navigation to installation instructions.

Signed-off-by: Bonusree <bonusree@appscode.com>
@coderabbitai

coderabbitai Bot commented Jun 18, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

Across 50 documentation files covering 12 database products (Cassandra, Druid, Elasticsearch, MariaDB, MongoDB, MSSQL Server, MySQL, PostgreSQL, Qdrant, Redis, SingleStore, ZooKeeper), the KubeStash and KubeDB installation links are updated from specific subpaths (/setup/install/kubestash or /setup/install/kubedb/) to the general https://kubestash.com/docs/latest/setup/ or equivalent top-level setup page. One MariaDB overview file also adds a "New to KubeDB? Please start here" link.

Changes

Installation URL link updates across backup and schema-manager guides

Layer / File(s) Summary
KubeStash install URL updates across backup guides
docs/guides/cassandra/backup/kubestash/*/index.md, docs/guides/druid/backup/*/index.md, docs/guides/elasticsearch/backup/kubestash/*/index.md, docs/guides/mariadb/backup/kubestash/*/index.md, docs/guides/mongodb/backup/kubestash/*/index.md, docs/guides/mssqlserver/backup/*/index.md, docs/guides/mysql/backup/kubestash/*/index.md, docs/guides/postgres/backup/kubestash/*/index.md, docs/guides/qdrant/backup/*/index.md, docs/guides/redis/backup/kubestash/*/index.md, docs/guides/singlestore/backup/kubestash/*/index.md, docs/guides/zookeeper/backup/kubestash/*/index.md
47 files replace the KubeStash install link from the specific /setup/install/kubestash subpath to https://kubestash.com/docs/latest/setup/ in "Before You Begin" prerequisites and overview warning notices. The MariaDB overview also adds a "New to KubeDB? Please start here" link.
KubeDB install URL updates in MongoDB schema-manager guides
docs/guides/mongodb/schema-manager/deploy-mongodbdatabase/index.md, docs/guides/mongodb/schema-manager/initializing-with-script/index.md, docs/guides/mongodb/schema-manager/initializing-with-snapshot/index.md
Three MongoDB schema-manager guides replace the KubeDB installation link from /setup/install/kubedb/ to the general /docs/latest/setup/ path.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐇 Hop, hop, through the docs we go,
Old install paths were quite a show,
/setup/install/kubestash? No more!
/docs/latest/setup/ — simpler than before.
Fifty files updated with a single bound,
The cleanest trail a rabbit ever found! 🌿

🚥 Pre-merge checks | ✅ 5
✅ 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 'installation link fixed' is directly related to the changeset, which updates 47 documentation files to change KubeStash and KubeDB installation links from specific install paths to general setup pages.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
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.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch link-fix

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 and usage tips.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🧹 Nitpick comments (1)
docs/guides/mongodb/schema-manager/initializing-with-snapshot/index.md (1)

23-23: 💤 Low value

Replace non-descriptive link text with a descriptive alternative.

The link text "here" is not descriptive and violates markdown best practices. Use text that describes the link destination, such as "KubeDB installation guide".

📝 Suggested fix
- Install `KubeDB` in your cluster following the steps [here](https://kubedb.com/docs/latest/setup/).
+ Install `KubeDB` in your cluster following the [KubeDB installation guide](https://kubedb.com/docs/latest/setup/).
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/guides/mongodb/schema-manager/initializing-with-snapshot/index.md` at
line 23, The link text "here" in the sentence about installing KubeDB is not
descriptive and violates markdown best practices. Replace the link text "here"
with descriptive text that clearly indicates the destination, such as "KubeDB
installation guide" or "KubeDB setup instructions", so readers understand what
they will find at the link without clicking it.

Source: Linters/SAST tools

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Nitpick comments:
In `@docs/guides/mongodb/schema-manager/initializing-with-snapshot/index.md`:
- Line 23: The link text "here" in the sentence about installing KubeDB is not
descriptive and violates markdown best practices. Replace the link text "here"
with descriptive text that clearly indicates the destination, such as "KubeDB
installation guide" or "KubeDB setup instructions", so readers understand what
they will find at the link without clicking it.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: dc9bc86b-1b40-4126-8eed-df3def80debd

📥 Commits

Reviewing files that changed from the base of the PR and between 7170308 and 0abcf34.

📒 Files selected for processing (49)
  • docs/guides/cassandra/backup/kubestash/logical/index.md
  • docs/guides/cassandra/backup/kubestash/overview/index.md
  • docs/guides/druid/backup/application-level/index.md
  • docs/guides/druid/backup/auto-backup/index.md
  • docs/guides/druid/backup/cross-ns-dependencies/index.md
  • docs/guides/druid/backup/logical/index.md
  • docs/guides/druid/backup/overview/index.md
  • docs/guides/elasticsearch/backup/kubestash/auto-backup/index.md
  • docs/guides/elasticsearch/backup/kubestash/logical/index.md
  • docs/guides/elasticsearch/backup/kubestash/overview/index.md
  • docs/guides/mariadb/backup/kubestash/application-level/index.md
  • docs/guides/mariadb/backup/kubestash/auto-backup/index.md
  • docs/guides/mariadb/backup/kubestash/logical/index.md
  • docs/guides/mariadb/backup/kubestash/overview/index.md
  • docs/guides/mongodb/backup/kubestash/application-level/index.md
  • docs/guides/mongodb/backup/kubestash/auto-backup/index.md
  • docs/guides/mongodb/backup/kubestash/logical/replicaset/index.md
  • docs/guides/mongodb/backup/kubestash/logical/sharding/index.md
  • docs/guides/mongodb/backup/kubestash/logical/standalone/index.md
  • docs/guides/mongodb/backup/kubestash/overview/index.md
  • docs/guides/mongodb/schema-manager/deploy-mongodbdatabase/index.md
  • docs/guides/mongodb/schema-manager/initializing-with-script/index.md
  • docs/guides/mongodb/schema-manager/initializing-with-snapshot/index.md
  • docs/guides/mssqlserver/backup/application-level/index.md
  • docs/guides/mssqlserver/backup/auto-backup/index.md
  • docs/guides/mssqlserver/backup/logical/index.md
  • docs/guides/mssqlserver/backup/overview/index.md
  • docs/guides/mysql/backup/kubestash/application-level/index.md
  • docs/guides/mysql/backup/kubestash/auto-backup/index.md
  • docs/guides/mysql/backup/kubestash/logical/index.md
  • docs/guides/mysql/backup/kubestash/overview/index.md
  • docs/guides/postgres/backup/kubestash/application-level/index.md
  • docs/guides/postgres/backup/kubestash/auto-backup/index.md
  • docs/guides/postgres/backup/kubestash/logical/index.md
  • docs/guides/postgres/backup/kubestash/overview/index.md
  • docs/guides/qdrant/backup/logical/index.md
  • docs/guides/qdrant/backup/overview/index.md
  • docs/guides/qdrant/backup/volume-snapshot/index.md
  • docs/guides/redis/backup/kubestash/application-level/index.md
  • docs/guides/redis/backup/kubestash/auto-backup/index.md
  • docs/guides/redis/backup/kubestash/logical/index.md
  • docs/guides/redis/backup/kubestash/overview/index.md
  • docs/guides/singlestore/backup/kubestash/application-level/index.md
  • docs/guides/singlestore/backup/kubestash/auto-backup/index.md
  • docs/guides/singlestore/backup/kubestash/logical/index.md
  • docs/guides/singlestore/backup/kubestash/overview/index.md
  • docs/guides/zookeeper/backup/kubestash/auto-backup/index.md
  • docs/guides/zookeeper/backup/kubestash/logical/index.md
  • docs/guides/zookeeper/backup/kubestash/overview/index.md

@github-actions

Copy link
Copy Markdown

Visit the preview URL for this PR (updated for commit 0abcf34):

https://kubedb-v2-hugo--pr893-link-fix-vrplbkol.web.app

(expires Thu, 25 Jun 2026 12:05:57 GMT)

🔥 via Firebase Hosting GitHub Action 🌎

Sign: 0f29ae8ae0bd54a99bf2b223b6833be47acd5943

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant