RFE: document HCL config key names along side CLI arguments
- Dominant language
- Go
- Stars
- 30.1k
- Forks
- 4.6k
- Avg merge
- 1d 18h
- Merged PRs (30d)
- 39
Description
#### Feature Description
It should be documented when the HCL config key name is not the same as the
command line argument. `-node` vs `node_name`, `-join` vs `start_join`.
These differences should be highlighted clearly in the documentation beside their corresponding
CLI arguments.
#### Use Case(s)
1. Converting CLI arguments to HCL configuration
1. Reduce confusion: it is unexpected and confusing to see `invalid config key join` or `invalid config key node`
Contributor guide
Research direction
No files or tests are named. Locate the documentation for the `-node`/`node_name` and `-join`/`start_join` options, then review nearby CLI arguments for other differing HCL keys. Done means each mismatch is clearly documented beside its corresponding argument.
Written by the indexing model from the issue text.
Assessment
- Domain
- cli, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100