Add config:cluster_config()

Open Beginner friendly
#5,689 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
1-3 hours
Newbie friendliness
82/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Quiet
Domain
documentation

Research direction

Open the linked config reference document and find the section where cluster configuration APIs are described. Add documentation for config:cluster_config(), including that it returns the merged raw cluster configuration without defaults or template substitution; done when the new entry appears under the config reference.

Written by the indexing model from the issue text.

Description

config:cluster_config()

Get a raw cluster configuration after merging all cluster
configuration sources. Default values are not applied and
template variables are not substituted.

Return:

a cluster configuration

Root document: https://www.tarantool.io/en/doc/latest/reference/reference_lua/config/
Requested by @mandesero in https://github.com/tarantool/tarantool/commit/288feeece57c2ff41c5e9f3ecc00378aeacf0a7b.

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

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.

More from tarantool/doc

All issues in tarantool/doc

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.