[3pt] feedback: Справочник по API | Introduce "virtual bucket" as term
Nobody has claimed this yet.
- Dominant language
- CSS
- Stars
- 15
- Forks
- 49
- Avg merge
- 1d 13h
- Merged PRs (30d)
- 3
Description
Product: Tarantool, VShard
Root document: https://www.tarantool.io/ru/doc/latest/reference/reference_rock/vshard/vshard_api/#router-api-info
Details
In the API reference, the term "virtual bucket" is translated into Russian as «виртуальный сегмент».
The term «сегмент» is not introduced properly.
Users get confused and do not understand that by «сегмент» the document means "bucket".
The term "virtual bucket" should also be introduced properly in the "Sharding" document and the "Architecture" document.
Definition of done
- The term "virtual bucket" is introduced as :term: in "Sharding" and "Architecture".
- In the API reference, it is clearly mentioned that by «сегмент» the document means "bucket".
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 linked Sharding and Architecture documents, then review the Router API reference at the specified section. Introduce “virtual bucket” as a term in the first two documents and clarify in the API reference that «сегмент» means “bucket”; the three checklist items define done.
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
- Clearly specified
- Newbie friendliness
- 72/100