tarantool / tarantool/doc

[2pt] feedback: Developer’s guide

Open
#2,371 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

add details cartridge
Dominant language
CSS
Stars
15
Forks
49
Avg merge
1d 13h
Merged PRs (30d)
3

Description

Looks like part of #1651

Product: Cartridge
Audience/target: dev
Root document: https://www.tarantool.io/en/doc/latest/book/cartridge/cartridge_dev/#defining-role-dependencies
SME: @ yngvar-antonsson

The information the user is looking for can be found on the same page:
"If a custom role has dependent roles, the dependencies are registered and validated first, prior to the role itself."


<…>
implement the functions you need.

Defining role dependencies
|You can instruct the cluster to apply some other roles if your custom role
is enabled.|

For example:
-- Role dependencies defined in app/roles/custom-r<…>

https://www.tarantool.io/en/doc/latest/book/cartridge/cartridge_dev/#defining-role-dependencies

The documentation does not make it clear, whether it is guaranteed that a role will be initiaized strictly after all its dependencies.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Open the linked Cartridge developer guide at the “Defining role dependencies” section and review the existing explanation and example. Confirm whether initialization is guaranteed to occur after all dependent roles, then update the documentation to state the ordering clearly and verify the rendered page.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.