[Epic] Document TT CLI - future plans
Nobody has claimed this yet.
- Dominant language
- CSS
- Stars
- 15
- Forks
- 49
- Avg merge
- 1d 13h
- Merged PRs (30d)
- 3
Description
Total: 4 sp
--
Dev board ref.:
https://github.com/tarantool/roadmap-internal/issues/59
https://github.com/tarantool/tt/issues/8
PM ref.: https://www.notion.so/tarantool/TT-CLI-80cbe807b1d14aaa92a32f936d5271af
Unified command-line interface for Tarantool.
SME: @ LeonidVas
Follow-up of #3168
This epic is a container for doc tasks for features that aren't developed yet (as of March 2023).
We don't have specific plans on writing these docs, just defining the possible scope.
Tasks
Create a Cartridge CLI-style reference.
Batch 5 (9sp)
- https://github.com/tarantool/doc/issues/2563
- https://github.com/tarantool/doc/issues/3156
- https://github.com/tarantool/doc/issues/3273
- https://github.com/tarantool/doc/issues/2562
--
Total: 9 sp
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 by reviewing the Cartridge CLI-style reference and the linked task issues #2563, #3156, #3273, and #2562, along with follow-up issue #3168. Define the possible scope for TT CLI documentation; this epic is done when the future documentation tasks are clearly identified, not when a specific document is written.
Written by the indexing model from the issue text.
Assessment
- Domain
- cli, documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100