apache / apache/openwhisk

Create a single list of all deployment parameters with description

Open
#3,645 0 comments 2 reactions 0 assignees View on GitHub
documentation
Dominant language
Scala
Stars
6.8k
Forks
1.2k
Avg merge
2d 14h
Merged PRs (30d)
2

Description

We have several places where OW deployment parameters could be configured (pureConf, ansible vars), some of the params are well documented, some are not, others are rotten. It would be useful to consolidate all component parameters in a single place preserving the following information:
1. Parameter name
2. Component
3. Default value
4. Type (pureConf, ansible, other)
5. Description

Additionally it would be a real boon to create a simple script to automatically check (if possible) if newly added parameters are listed in the doc, potentially add it to Travis to warn us if the params are not documented.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.