Add examples of compatible versions
Nobody has claimed this yet.
- Dominant language
- CSS
- Stars
- 15
- Forks
- 49
- Avg merge
- 1d 13h
- Merged PRs (30d)
- 3
Description
Connected with #2218
Product: Tarantool
Root document: where to add or update documentation
SME: @ Totktonada
Details
Compatibility guarantees
Backwards compatibility is guaranteed between all versions in the same :term:
release series.
It is also appreciated but not guaranteed between different release series (major number changes). Example.
Pre-releases and releases of one release series are compatible in all
senses defined below (any release with any release):
Pre-releases and releases of consequent series are compatible by data
layout, binary protocol, and replication protocol. Example.No guarantees are given regarding compatibility between
pre-releases/releases of non-consequent release series if the opposite
is not stated in the :doc:release notes <notes>. Example.No guarantees are given regarding compatibility between alpha/beta
versions and between alpha/beta and pre-release/release even within one series. Example.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Read the compatibility guarantees section quoted in the issue and review related issue #2218. Locate the root documentation file, which is not named here, then add concrete compatible-version examples at each marked placeholder. The work is done when all three compatibility cases have clear examples in the rendered documentation.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100