Machine.Files clarification
Nobody has claimed this yet.
- Dominant language
- MDX
- Stars
- 11
- Forks
- 76
- Avg merge
- 3d 5h
- Merged PRs (30d)
- 26
Description
We should update the Config document so machine.files properly clarifies what files can/can't be edited/injected via this hook. @frezbo mentioned we have validation in place but the documentation doesn't reflect that meaning a user would get unexpected errors when trying to configure this way. Documentation should reflect what the validation allows/blocks.
Contributor guide
No contributing guide indexed for this repository
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 public/talos/v1.13/reference/configuration/v1alpha1/config.mdx and its machine.files section, then inspect the validation referenced in the issue to identify which files are allowed or blocked. Update the Config document so the documented behavior matches validation and users can tell what configurations will be accepted.
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
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 72/100