[DOCS] Pillar include subkey separator not documented
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 15.7k
- Forks
- 5.6k
- Avg merge
- 2d 44m
- Merged PRs (30d)
- 80
Description
Description
Pillar include subkey separator not documented
Suggested Fix
Document how to include pillar data in a key other than toplevel
Type of documentation
Salt documentation
Location or format of documentation
https://docs.saltproject.io/en/latest/topics/pillar/index.html#including-other-pillars
Additional context
The subkey separator is shown as colon eg. here https://github.com/saltstack/salt/pull/58736/files#diff-4df8c90e2fa6fc620b2cffe4e099fef19f6245822ecef60acddd4c4acadf65d0R39-R41 but it is not documented.
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 at the Salt documentation page under the “Including other pillars” section, then compare it with the cited pull request diff. Document the subkey separator and how to include pillar data below the top-level key; done means the page explains this behavior clearly with an appropriate example.
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
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 55/100