Outdated and duplicate information in memtx section
Nobody has claimed this yet.
- Dominant language
- CSS
- Stars
- 15
- Forks
- 49
- Avg merge
- 1d 13h
- Merged PRs (30d)
- 3
Description
Related dev. issue(s):
Product: Tarantool
Since: 2.6.1
Audience/target:
Root document: https://www.tarantool.io/en/doc/latest/book/box/engines/memtx/
SME: @ Mons, @ alyapunov
Details
After updating the transaction section (https://www.tarantool.io/en/doc/latest/book/box/atomic/), some information in the memtx section is somewhat out of date and needs updating in terms of the memory model (and in general information is duplicated, it is worth considering this and possibly using links to material from another page).
Definition of done
- The information about memtx has been updated.
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
Start with the memtx root document and compare its transaction and memory-model information with the atomic transactions page linked in the issue. Review the duplicated material and update or replace it with links where appropriate; done means the memtx information is current and no longer unnecessarily duplicated.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100