[WIP] add migration docs and release notes #1316
Merged
Conversation
This file contains 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
16 tasks
taylorreiter
reviewed
Feb 9, 2021
Co-authored-by: Taylor Reiter <[email protected]>
Co-authored-by: Taylor Reiter <[email protected]>
Co-authored-by: Taylor Reiter <[email protected]>
Co-authored-by: Taylor Reiter <[email protected]>
Co-authored-by: Taylor Reiter <[email protected]>
|
thank you very much @taylorreiter !! |
taylorreiter
reviewed
Feb 9, 2021
|
@taylorreiter please see last set of changes here, b041bb8. @luizirber I'm happy to wait for your review if you like, just lmk. |
|
thanks, fixed! gonna merge before luiz jumps in 😁 |
ctb
added a commit
that referenced
this pull request
Feb 17, 2021
* start adjusting docs * add migration links * switch compute over to sketch in most of the markdown docs * fix --scaled and --track-abundance thruought * formatting and wording fixes * add sourmash sketch docs * substantial update for API examples * add ToC to api-example * fix heading for API section * bold API examples link * (untested) update of tutorials to use sourmash sketch * update link targets * updates of indexed databases * typos in versioning (#1314) * Apply suggestions from code review Co-authored-by: Taylor Reiter <[email protected]> * Update doc/api-example.md Co-authored-by: Taylor Reiter <[email protected]> * updated with suggestions from @taylorreiter doc review * added section on sketch naming * [WIP] add migration docs and release notes (#1316) * add migration docs and release notes * Update doc/support.md Co-authored-by: Taylor Reiter <[email protected]> * Update doc/support.md Co-authored-by: Taylor Reiter <[email protected]> * Update doc/release-notes/sourmash-4.0.md Co-authored-by: Taylor Reiter <[email protected]> * Update doc/release-notes/sourmash-4.0.md Co-authored-by: Taylor Reiter <[email protected]> * Update doc/release-notes/sourmash-4.0.md Co-authored-by: Taylor Reiter <[email protected]> * update with last set of changes * add missing line break Co-authored-by: Taylor Reiter <[email protected]> * resolve missing link * update tutorials and notebooks for 4.0 * [MRG] update the migration guide for 4.0 with version pinning instructions (#1330) * update 4.0 migration docs with version pinning instructions * update migration docs * Apply suggestions from code review Co-authored-by: Luiz Irber <[email protected]> * Apply suggestions from code review Co-authored-by: Luiz Irber <[email protected]> Co-authored-by: Taylor Reiter <[email protected]> Co-authored-by: Luiz Irber <[email protected]>
ctb
added a commit
that referenced
this pull request
Feb 18, 2021
* start adjusting docs * add migration links * switch compute over to sketch in most of the markdown docs * fix --scaled and --track-abundance thruought * formatting and wording fixes * add sourmash sketch docs * substantial update for API examples * add ToC to api-example * fix heading for API section * bold API examples link * (untested) update of tutorials to use sourmash sketch * update link targets * updates of indexed databases * typos in versioning (#1314) * Apply suggestions from code review Co-authored-by: Taylor Reiter <[email protected]> * Update doc/api-example.md Co-authored-by: Taylor Reiter <[email protected]> * updated with suggestions from @taylorreiter doc review * added section on sketch naming * [WIP] add migration docs and release notes (#1316) * add migration docs and release notes * Update doc/support.md Co-authored-by: Taylor Reiter <[email protected]> * Update doc/support.md Co-authored-by: Taylor Reiter <[email protected]> * Update doc/release-notes/sourmash-4.0.md Co-authored-by: Taylor Reiter <[email protected]> * Update doc/release-notes/sourmash-4.0.md Co-authored-by: Taylor Reiter <[email protected]> * Update doc/release-notes/sourmash-4.0.md Co-authored-by: Taylor Reiter <[email protected]> * update with last set of changes * add missing line break Co-authored-by: Taylor Reiter <[email protected]> * resolve missing link * update tutorials and notebooks for 4.0 * fix link; add GTDB mention; logo positioning * minor fixes and updates * no need for pysam and htslib any more * fix words * Update README.md Co-authored-by: Luiz Irber <[email protected]> Co-authored-by: Taylor Reiter <[email protected]> Co-authored-by: Luiz Irber <[email protected]>
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.
Add release notes and migration docs to the 4.0 doc update.
NOTE: PR into #1283.
TODO:
Checklist
make testDid it pass the tests?make coverageIs the new code covered?without a major version increment. Changing file formats also requires a
major version number increment.
changes were made?