Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[2pt] Create a guideline for describing Tarantool configuration parameters #2723

Closed
Tracked by #2665
veod32 opened this issue Feb 24, 2022 · 1 comment · Fixed by #2869
Closed
Tracked by #2665

[2pt] Create a guideline for describing Tarantool configuration parameters #2723

veod32 opened this issue Feb 24, 2022 · 1 comment · Fixed by #2869
Assignees
Labels
guidelines internal Technical debt in the docs

Comments

@veod32
Copy link
Collaborator

veod32 commented Feb 24, 2022

Root document: https://www.tarantool.io/en/doc/latest/contributing/docs/examples/

ToDo

Create a guideline for describing Tarantool configuration parameters and API function parameters (:param:).

We already have templates for documenting functions, classes, methods, and data. But description of configuration parameters has its own specifics. The following info should be provided for each parameter:

  • Since which Tarantool version
  • General description with all the details and examples (if needed)
  • Type
  • Corresponding environment variable
  • Default value
  • Dynamic (yes or no)
  • Possible errors
@veod32 veod32 changed the title [0pt] {feature_name} [2pt] Create a guideline for describing Tarantool configuration parameters Feb 24, 2022
@veod32 veod32 added internal Technical debt in the docs guidelines labels Feb 24, 2022
@patiencedaur
Copy link
Contributor

patiencedaur commented May 12, 2022

Do this next: #2722

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
guidelines internal Technical debt in the docs
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants