Document advice about how to use config merging
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 974
- Forks
- 296
- Avg merge
- 6d 14h
- Merged PRs (30d)
- 9
Description
We document the semantics of config merging but we don't provide any advice on how to use it. Document some examples, e.g. a hierarchical config structure with a parent config that merges a base config plus environment-specific child configs overriding pieces of the parent.
In particular, we should point out that an uncompressed child resource overriding the compressed contents of a parent should set compression to "".
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the existing documentation that explains config-merging semantics. Add examples of hierarchical parent and environment-specific child configs, including the case where an uncompressed child overrides compressed parent contents by setting compression to "". Done means the usage guidance and this override rule are documented.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100