Misprint at cartridge failover page
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): N/A
Product: Cartridge
Since: N/A
Audience/target: developers/admins to operate the Cartridge cluster
Root document: description of promote function arguments
SME: @ Sergos
Details
Current description is following:
Parameters:
- replicaset_uuid: (table) ] = leader_uuid }
- opts:
[...]
Definition of done
The description should be:
Parameters:
replicaset_uuid: (table) { ['replicaset_uuid'] = leader_uuid }
opts:
[...]
Planning checklist
-
- user_guide, etc.
- Estimate complexity in storypoints in the title
- Add to Documentation board → Backlog
Note: issue templates are in beta. Give your feedback in #1869.
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
Open the linked Cartridge API documentation page for the promote function and inspect its Parameters section. Correct the replicaset_uuid example to use { ['replicaset_uuid'] = leader_uuid } while retaining the opts entry, then verify the rendered description matches the issue's Definition of done.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- lua
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 55/100