Skip to content

Updated README#3382

Open
priyanshi-yb wants to merge 1 commit into
mainfrom
priyanshi/readme-update
Open

Updated README#3382
priyanshi-yb wants to merge 1 commit into
mainfrom
priyanshi/readme-update

Conversation

@priyanshi-yb

@priyanshi-yb priyanshi-yb commented Feb 19, 2026

Copy link
Copy Markdown
Contributor

Describe the changes in this pull request

Describe if there are any user-facing changes

How was this pull request tested?

Does your PR have changes in callhome/yugabyted payloads? If so, is the payload version incremented?

Does your PR have changes to on-disk structures that can cause upgrade issues?


Reference

On-disk structures potentially causing breaking changes:

Component
MetaDB
Name registry json
Data File Descriptor Json
Export Snapshot Status Json
Callhome Json
Export Status Json
YugabyteD Tables
TargetDB Metadata Tables
Schema Dump
AssessmentDB
Migration Assessment Report Json
Import Data State
Export and import data queue
Data .sql files of tables

Note

Low Risk
Documentation-only updates (README/release notes link) with no code-path or behavioral changes; main risk is stale/incorrect links or installation commands.

Overview
Updates README.md to be a more complete entrypoint: adds a Table of Contents, rewrites the feature list, documents supported source/target databases and migration types, and adds explicit prerequisites, installation methods (brew/apt/yum/docker/source/airgapped), and a step-by-step migration workflow with updated documentation links.

Updates RELEASE_NOTES.md to point readers to the official documentation for the latest release notes.

Written by Cursor Bugbot for commit 2c77a16. This will update automatically on new commits. Configure here.

@priyanshi-yb priyanshi-yb marked this pull request as ready for review February 19, 2026 07:51
Comment thread README.md
- Live migration of Oracle databases with fall-forward and fall-back.
- Direct data import from CSV or TEXT format files on local disk or cloud storage.
- Parallelism of data across tables and within tables.
- Auto-tuneable based on workloads, by analyzing the target cluster capacity.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

I like the "Optimized for distributed databases" category. SHall we keep that?

Comment thread README.md
- [YugabyteDB Anywhere](https://docs.yugabyte.com/preview/yugabyte-platform/create-deployments/)
- [YugabyteDB Aeon](https://docs.yugabyte.com/preview/yugabyte-cloud/cloud-basics/)

# Current Product State and Roadmap

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

IMO, better to run this by Hemant/AV.
Should be okay to remove as this is outdated, but we should at least discuss if we want to have an updated one, or it's fine.

Comment thread README.md
For detailed version compatibility across migration types, refer to the [target database documentation](https://docs.yugabyte.com/preview/yugabyte-voyager/introduction/#target-database).

<img src="docs/voyager_current_state_and_roadmap.png" align="center" alt="YugabyteDB Voyager Architecture"/>
## Migration Types

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Should this come after Migration Workflow below? And maybe let's call it "Data Migration Types/Workflows"?

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.

2 participants