[2pt] feedback: Module custom-role | Tarantool
Nobody has claimed this yet.
- Dominant language
- CSS
- Stars
- 15
- Forks
- 49
- Avg merge
- 1d 13h
- Merged PRs (30d)
- 3
Description
Product: Cartridge
Audience/target: dev
Root document: https://www.tarantool.io/ru/doc/latest/book/cartridge/cartridge_api/modules/custom-role/
SME: @ rosik @ sergos
Details
The document needs a link to the cartridge.rpc() doc:
https://www.tarantool.io/ru/doc/latest/book/cartridge/cartridge_api/modules/cartridge.rpc/
The document was generated from this Lua file: https://github.com/tarantool/cartridge/blob/master/cartridge/user-defined-role.lua
<…>
Module custom-role
User-defined role API.
|If you want to implement your own role it must conform this API.|Functions
init (opts)
Role initialization callback.
Called wh<…>
https://www.tarantool.io/ru/doc/latest/book/cartridge/cartridge_api/modules/custom-role/
Нет описания RPC функций для cartridge.rpc.call()
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
Read the generated custom-role documentation and its source in cartridge/user-defined-role.lua, then compare it with the cartridge.rpc() documentation linked in the issue. Add the missing link and RPC function descriptions to the custom-role document, and confirm the published page contains them.
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
- 45/100