[DOCS] clarify pillar datastructure of underlying yaml
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 15.7k
- Forks
- 5.6k
- Avg merge
- 2d 44m
- Merged PRs (30d)
- 80
Description
Description
Some users are having difficulty when setting up pillar in referencing those different pillar structures after words.
Suggested Fix
describe in detail how the different layouts in pillar data affect the change in the underlying data structure when being reference in jinja as well as describe how the json data relates.
Type of documentation
Salt documentation and getting started guide.
Location or format of documentation
https://docs.saltproject.io/en/latest/topics/tutorials/pillar.html
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 pillar tutorial at the linked Salt documentation location and review how its current examples describe pillar layouts. Document how each layout changes the underlying data structure when referenced in Jinja, and explain how the corresponding JSON data relates. Done means the getting-started documentation clearly covers these structures and references.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- json, yaml
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100