Repository navigation
Document the fork and correct the install paths - #66
Closed
teknogeek0 wants to merge 1 commit into
Closed
teknogeek0 wants to merge 1 commit into
teknogeek0 wants to merge 1 commit into
Conversation
State that PlanetScale launched this fork in 2026 and maintains it directly, in the README, the docs landing page and the contributing guide. PlanetScale does not target parity with the upstream project and does not merge this work back to it. Dimitri Fontaine is credited as the author of the original project. The install page pointed at package repositories and container images that do not carry this fork. It now describes the two paths that work: the images at ghcr.io/planetscale/pgcopydb, whose version tags carry no leading "v", and a source build. The build dependencies are the current Ubuntu 24.04 list, and the page links the migration-scripts templates that provision a migration host the same way. The plugin section of features.rst listed only test_decoding and wal2json. It now covers pgoutput, which is the default, including how pgcopydb manages the publication and what privileges that needs. Add docs/operations.rst for the options this fork added for large migrations: deferred index builds, foreign key handling, same-table concurrency, restore tolerance, CDC disk use, and what happens when a source reconnects or changes timeline. Drop .readthedocs.yaml and the readthedocs links. Nothing publishes there.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Documentation only. No code changes.
The fork
States that PlanetScale launched this fork in 2026 and maintains it directly, that it does not target parity with the upstream project and does not merge work back to it, and that direction comes from what customers need when they migrate production databases. The statement lives in three places: a new "About this fork" section at the top of the README, the docs landing page, and the top of the contributing guide.
Dimitri Fontaine is credited as the author of the original project, in the README, the docs landing page and the Sphinx copyright. The first-person voice about him is gone from
docs/index.rst.Install paths
The install page sent readers to things that do not carry this fork:
apt.postgresql.organdyum.postgresql.orgpackage the upstream project. Both sections are removed.dimitri/pgcopydbrepository and threeghcr.io/dimitri/pgcopydbpulls. Replaced withghcr.io/planetscale/pgcopydb.v-prefixed version tag. Our published tags carry nov—0.19.0exists,v0.19.0does not. Verified against the registry.PATHso the build findspg_config, and a link to those templates.No upstream references remain in the install or getting-started pages.
Content
features.rstdescribed the plugin choice astest_decodingorwal2jsonand never mentionedpgoutput, which has been the default since Add pgoutput logical decoding plugin and make it the default #58. It now covers pgoutput, how pgcopydb manages the publication from--filters, and the privileges that needs.docs/operations.rst, wired into the toctree. The flags this fork added existed only as generated help text, with no prose saying when to use them:--defer-indexes,--defer-validate-fks,--defer-analyze,--split-tables-larger-than,--split-max-parts,--estimate-table-sizes,--restore-tolerance,--prune-threshold,--prune-min-age, plus the automaticNOT VALIDretry, the reconnect behavior, and the timeline change check..readthedocs.yamlis deleted along with the readthedocs links in the README and the contributing guide. Nothing publishes there.Checks
sphinx-buildsucceeds. The two remaining warnings are pre-existing:docs/include/list-triggers.rstanddocs/include/list-views.rstare not in any toctree.Regenerating
docs/include/*.rstfrom the built binary produces no diff, so the generated CLI reference is already current and this PR does not touch it.