[3pt] feedback: Configuration reference | Tarantool
Nobody has claimed this yet.
- Dominant language
- CSS
- Stars
- 15
- Forks
- 49
- Avg merge
- 1d 13h
- Merged PRs (30d)
- 3
Description
Root document: https://www.tarantool.io/en/doc/latest/reference/reference_rock/vshard/vshard_ref/
SME: @ Gerold103
Details
Feedback:
"
<…>efining the logical topology of the sharded Tarantool cluster.
|Type: table|
Default: false
Dynamic: yesweights
A field defining the c<…>
Where I can find description of content of this table?"
Ask @ Gerold103 if it's an issue worth working on.
Do users really need to know the content of the table?
If yes, then we need to update the description of this parameter.
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 vshard configuration reference at the linked root document and locate the parameter whose table contents are questioned. Ask @Gerold103 whether users need this information; if confirmed, update that parameter's description to explain the table contents and verify the rendered reference page.
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
- 35/100