Introduction to Cartridge API
Nobody has claimed this yet.
- Dominant language
- CSS
- Stars
- 15
- Forks
- 49
- Avg merge
- 1d 13h
- Merged PRs (30d)
- 3
Description
Add examples to Cartridge API
Product: Cartridge
Audience/target: пользователи, которые эксплатируют Cartridge и разрабатывают на нем
Root document: https://www.tarantool.io/en/doc/latest/book/cartridge/cartridge_api/
SME: @ expert to ask for more information
Peer reviewer: @ documentarian name
Details
https://app.mopinion.com/dashboard/inbox/detail/2999298
Listed modules could have some examples, it's not immediately clear how to use them.
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 root document at https://www.tarantool.io/en/doc/latest/book/cartridge/cartridge_api/ and review the listed Cartridge API modules. Identify which modules lack usage examples and clarify the intended examples with the referenced SME. Done means the relevant modules contain clear examples for users who operate and develop with Cartridge.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100