tt instance parameters in instances.yml
Nobody has claimed this yet.
- Dominant language
- CSS
- Stars
- 15
- Forks
- 49
- Avg merge
- 1d 13h
- Merged PRs (30d)
- 3
Description
Epic: Document TT CLI
Product: Tarantool CLI
Since: TBD
Audience/target: dev, admin
Root document: https://www.tarantool.io/en/doc/latest/reference/tooling/tt_cli/multiple_instances/
SME: @ 0x501D
Details
The doc on tt CLI instance configuration (instances.yml) reflects the first dev iteration: instances can have only names. However, the specification in the tt repo suggests that they will also have parameters:
instance_name:
parameter: value
Need to extend the user doc when parameters are implemented
Definition of done
- tt instance configuration doc contains the list of instance parameters with descriptions.
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 tt CLI instance configuration page linked in the issue and compare it with the tt repository's “working with a set of instances” specification. Wait for the parameters to be implemented, then document the supported instance parameters and their descriptions in the root document. Confirm the definition-of-done checklist is satisfied.
Written by the indexing model from the issue text.
Assessment
- Domain
- cli, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100