[13pt] Cartridge: restructure info about app start parameters and instances.yml
Nobody has claimed this yet.
- Dominant language
- CSS
- Stars
- 15
- Forks
- 49
- Avg merge
- 1d 13h
- Merged PRs (30d)
- 3
Description
Info about app start parameters including description of instances.yml is in the different guides and places:
https://www.tarantool.io/en/doc/1.10/book/cartridge/cartridge_cli/#starting-stopping-an-application-locally
https://www.tarantool.io/en/doc/latest/book/cartridge/topics/clusterwide-config/#configuration-basics
https://www.tarantool.io/en/doc/latest/book/cartridge/cartridge_dev/#starting-stopping-instances
https://www.tarantool.io/en/doc/latest/book/cartridge/cartridge_admin/#deploying-the-cluster
https://www.tarantool.io/en/doc/latest/book/cartridge/cartridge_api/modules/cartridge.argparse/
Possibly we need to collect the info and re-organise it in a more structured way (possibly, cross-references in diff. guides or re-writing some of the paragraphs).
This issue is a follow-up of https://github.com/tarantool/doc/issues/1520
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 comparing the five linked guides, especially the sections on local starts, clusterwide configuration, instance starts, deployment, and cartridge.argparse. Review the follow-up issue #1520 for context. Done means the app start parameters and instances.yml information are organized into a clear structure with appropriate cross-references or rewritten paragraphs across the affected guides.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100