Overwriting existing files: example in the documentation.
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 974
- Forks
- 296
- Avg merge
- 6d 14h
- Merged PRs (30d)
- 9
Description
Created originally in Butane by @mjordan79: https://github.com/coreos/butane/issues/499
I think that using the append directive is not immediate, so a small example in the documentation should be provided
Example documentation:
https://coreos.github.io/butane/examples/
Snippet to explain:
variant: fcos
version: 1.5.0
storage:
files:
- path: /etc/sudoers
overwrite: false
append:
- inline: |
core ALL=(ALL) NOPASSWD: /usr/bin/docker
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 with the examples page at https://coreos.github.io/butane/examples/ and review how existing storage file examples are structured. Add a small example using overwrite: false and append with an inline entry, and consider the work done when the documentation makes appending to an existing file immediately understandable.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Quiet
- Clarity
- Clearly specified
- Newbie friendliness
- 82/100