[DOCS] Example of per-saltenv gitfs root setting
Open
Nobody has claimed this yet.
doc-correction
documentation
severity-medium
time-estimate-sprint
ZD
- Dominant language
- Python
- Stars
- 15.7k
- Forks
- 5.6k
- Avg merge
- 2d 44m
- Merged PRs (30d)
- 80
Description
Description
The gitfs per-saltenv examples could use an example of using root. In particular, it might emphasize that per-saltenv root is a root, and is in no way additive to a globally-configured gitfs_root.
Suggested Fix
Add an example that uses a per-saltenv root setting.
Location or format of documentation
Additional context
ZD-5964.
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 linked GitFS documentation at the per-saltenv configuration parameters section and review the existing examples. Add an example using a per-saltenv root setting that makes clear it is a root rather than additive to a globally configured gitfs_root; the documentation should show this distinction clearly.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- git
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 55/100