Add comments to mixed-cluster upgrade code
- Dominant language
- Erlang
- Stars
- 7k
- Forks
- 1.1k
- Avg merge
- 1d 16h
- Merged PRs (30d)
- 9
Description
Via https://github.com/apache/couchdb/pull/4394#pullrequestreview-1263473784
It’d be nice if we tagged code that can be removed after we can expect everybody to have gone through a rolling cluster upgrade with the version number at which it can be removed, so we can semi-automate cleaning up said code.
We could decide to make it a promise that if someone wants to do a rolling upgrade from N-1 to N, that if they are on the latest N-1 release that they can upgrade safely and that N no longer has the upgrade code. But all versions inside N-1 can be rolling-upgraded.
That would reflect reality, especially outside IBM/Cloudant, where folks don’t track each and every CouchDB version.
cc @mikerhodes
Contributor guide
Research direction
Start by reviewing pull request #4394 and its linked review discussion, then locate the mixed-cluster upgrade code that needs annotation. Determine which upgrade paths are safe to remove and what version should be recorded; done means the relevant code is consistently tagged, with the intended cleanup point clear to maintainers.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- erlang
- Domain
- databases, distributed-systems, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100