docs: start writing upgrade guide #196
Open
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
13 tasks
13 tasks
palkerecsenyi
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Closes #188
Added documentation for the restructured
invenio-vcsmodule. This includes documentation related to upgrading/migrating the module and the database, as well as a new page on general usage and provider-specific configuration options. A new documentation page should be added for any future provider implementations.An example script is provided to assist with the manual migration of very large instances, but this is subject to customisation on a case-by-case basis. With sufficient care, it should theoretically be possible to migrate with zero downtime.
This commit on its own is UNRELEASABLE. We will merge multiple commits related to the VCS upgrade into the
vcs-stagingbranch and then merge them all intomasteronce we have a fully release-ready prototype. At that point, we will create a squash commit.