saltstack / saltstack/salt

[Docs] pillar documentation update

Open
#56,239 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Confirmed doc-rework documentation severity-medium time-estimate-sprint
Dominant language
Python
Stars
15.7k
Forks
5.6k
Avg merge
2d 44m
Merged PRs (30d)
80

Description

Description of Issue

As noted in closed ticket https://github.com/saltstack/salt/issues/55106 the documentation on pillars and pillar caching is confusing and needs an overhaul, likely the new working group can audit these docs and help with consistency and reader flow.

Setup

Possible docs to review (there may be more or less):

Steps to Reproduce Issue

(Include debug logs if possible and relevant.)

Versions Report

(Provided by running salt --versions-report. Please also mention any differences in master/minion versions.)

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the pillar.items and pillar.raw documentation pages and the pillar-cache-options section linked in the issue, then compare their explanations for consistency and reader flow. Done means the pillar and pillar-caching documentation has been audited and revised to remove confusing guidance; check the closed issue #55106 for context.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.