Refresh documentation for 0.7.0 release #297
Merged
Conversation
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
…on and defaults RE pg_dump
… source from.Additional minor updates and cleanup
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.
0.7.0 is bringing a number of breaking changes that result in a lot of docs that needed serious refreshing.
Note: Some links in this description will break after deleting the associated branch. They're here to make it easier for me to navigate now.
Main readme
Add quick start to main readme (current link). That's the piece I always want and can quickly modify for what I'm working on today. It feels a bit redundant with the Docker Usage section (current link) but I think that's okay in this case. (Open to opinions on that!)
Docker Run Readme current link
Run section (current link) now includes back to back sub-sections for internal vs external Postgres connections.
Replication instructions (current link) brought up to be more prominent. Not recommending as default usage (yet). Hinting at taking the
experimentalflag off this feature. It isn't off in the code yet, though I think I'll make that change before releasing 0.7.0 too.Changing from
--skip-dumpto--pg-dump. current linkImprovements about
--skip-nested. current link