Update upgrade docs #2991
Merged
Update upgrade docs #2991
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
jrhizor
reviewed
Apr 20, 2021
docs/tutorials/upgrading-airbyte.md
Outdated
| @@ -45,34 +49,34 @@ docker run --rm -v /tmp:/config airbyte/migration:0.20.0-alpha --\ | |||
| ``` | |||
|
|
|||
| {% hint style="info" %} | |||
| It may seem confusing that you need to specify the target version twice. The version passed as `--target-version` specifies the version to which the data will be migrated. Specifying the target version in the docker container tag makes sure that you are pulling an image that at least has the migration for the version you want. Technically the version used in the docker tag can be equal to or greater than the version you are upgrading to. For the simplicity of this tutorial we have them match. | |||
| It may seem confusing that you need to specify the target version twice. The version passed as `--target-version` specifies the version to which the data will be migrated. Specifying the target version in the docker container tag makes sure that you are pulling an image that at least has the migration for the version you want. Technically the version used in the docker tag can be equal to or greater than the version you are upgrading to. | |||
There was a problem hiding this comment.
Would it be less confusing if we just didn't suggest using --target-version? And then it would use the latest within the latest migration docker image?
There was a problem hiding this comment.
I put optional brackets and removed this hint, is that good?
jrhizor
approved these changes
Apr 21, 2021
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.
What
Reword document to make it clearer for less-technical users attempting to upgrade airbyte