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

Document all public variables in VARIABLES.md #304

Open
5 tasks
acch opened this issue Nov 25, 2020 · 0 comments
Open
5 tasks

Document all public variables in VARIABLES.md #304

acch opened this issue Nov 25, 2020 · 0 comments
Assignees
Labels
Component: Core Component: Documentation Type: Documentation Idicates issue is related to documentation. Type: Enhancement Type: Enhancement Indicates a request for feature to be improved.

Comments

@acch
Copy link
Contributor

acch commented Nov 25, 2020

All variables which can be set by users should be documented in VARIABLES.md. Documentation should include

  • variable name
  • example value
  • default value
  • description of what this variable controls / is used for

I've already started documenting variables (see #301), this issue is to keep track of the progress:

  • core/common
  • core/precheck
  • core/node
  • core/cluster
  • core/postcheck
@acch acch added Type: Enhancement Type: Enhancement Indicates a request for feature to be improved. Component: Core Component: Documentation Type: Documentation Idicates issue is related to documentation. labels Nov 25, 2020
@acch acch self-assigned this Nov 25, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component: Core Component: Documentation Type: Documentation Idicates issue is related to documentation. Type: Enhancement Type: Enhancement Indicates a request for feature to be improved.
Projects
None yet
Development

No branches or pull requests

2 participants