[DOCS] Consolidated documentation backlog tracker (81 items, 14 themes)

Start by reviewing the linked issues in the tracker and their discussion for context; the tracker lists 81 documentation tasks across 14 themes, with each checkbox linking to an original issue. Choose one item, read its original issue to identify the affected docs and acceptance criteria, then submit a focused PR for that item or a small cluster. Done means the selected documentation gap is addressed and the tracker item is checked.

Overview

Consolidated tracker for the remaining documentation issues on this repo. 81 items across 14 themes. Follow-up to the 2026-10 backlog cleanup (companion to #70468, #70469, #70498).

Scope

• Each checkbox below links the original issue for context. Original issues are closed and point here.
• Items are grouped by theme; one PR per item (or small cluster) is preferred.
• Items for modules that have been moved to saltext extensions are not in scope here — those should be filed against the extension's own docs.

Progress

Config options documentation gaps (12)

• #69109 — Out of date reference minion configuration for retry_dns
• #66884 — Update incorrect details for log_granular_levels section of doc/ref/configuration/logging/index.rst
• #66533 — Multi-Master DNS Retry Timeout
• #66270 — Request channel documented default incorrect
• #65866 — Document changed default value for grains.fqdns
• #59910 — fips_mode is an undocumented opt for minion and master configs
• #50348 — New use_superseded option needs added to configuration documentation
• #56214 — [DOC]: Salt CLI doc is outdated
• #56192 — Inconsistent jinja samples for filters added in version 3000
• #58112 — [EPIC] Documented options in minion/master config files don't match minion/master config documentation, and vice versa
• #58893 — Is key_logfile meant to be a deprecated minion/master config option?
• #68170 — Salt 3007.x CHANGELOG entries get wiped out or replaced with each new 3007.x release

Release notes & changelog (6)

• #70241 — Include sitemap creation in the docs HTML bundle asset uploads for releases, and ensure last update timestamps present
• #70004 — Install Guide: Release Candidate
• #69530 — Salt 3008.0 release notes
• #68180 — Incorrect python version in changelog
• #65342 — Early release notes for 3006 still exist
• #65311 — When generating Release Notes for a Release of Salt, include date

Pillar documentation (12)

• #68765 — salt.sdb.yaml
• #68764 — Storing Data in Other Databases
• #66622 — Pillar include subkey separator not documented
• #66587 — state_top_saltenv documention is inaccurate in regard to when it applies
• #66556 — Construct variable from another variables
• #63110 — Add how to target on pillars from specific pillarenv
• #62816 — Migrating from grains.get_or_set_hash to sdb.get_or_set_hash
• #62802 — Confusion over running custom modules in pillar
• #62733 — Pillar Encryption should mention shebang renderers
• #61283 — clarify pillar datastructure of underlying yaml
• #60378 — default=<class 'KeyError'> in pillar.get
• #56239 — pillar documentation update

Reactor / scheduler / beacon docs (5)

• #66671 — scheduled-jobs page has a missing link to logging
• #65019 — Beacons Inotify Example Wrong for Onedir
• #63693 — Beacon inotify install instructions do not work
• #61616 — Beacons and reactors docs (version 3000.3) incorrect for accessing data dict
• #61332 — network_settings beacon doesn't list dependency.

Security / GPG / threat-model docs (6)

• #64289 — Review Security Docs - Security WG
• #62820 — Onedir Security Support
• #62144 — Introduce a Security and Threat Model documentation
• #63469 — key rejection is not mentioned in the guides when AES key rotation situations happens
• #59539 — Create includes note admonition in documentation referrencing GPG keys: GPG is used for all OpenPGP/PGP/GPG related material and implementations.
• #65682 — Homedir path in SALT.RENDERERS.GPG (ENCRYPTING DATA) are missing in few examples - bash/awk/perl

Cloud / salt-cloud docs (6)

• #65323 — salt-cloud script() function should not be listed as required
• #65064 — [SALT][CLOUD][OPTIONS] There was a query error: list index out of range
• #65063 — Inconsistent documentation of cloud options
• #64629 — Inconsistent documentation of cloud events
• #60679 — salt-cloud and register_image function
• #58719 — Extending Salt Cloud - outdated example of module that is using libcloud

Website / blog / infrastructure docs (7)

• #69531 — Recent Blogs on https://saltproject.io/
• #69417 — Resources Example Repo missing
• #69305 — saltipy is abandoned and unavailable on PyPI - salt-pepper should be the recommended Python client for salt-api
• #68123 — Homepage blog links do not work
• #68235 — Change point to internal links
• #65814 — Wrong link for saltext-docker
• #65437 — Instructions to build deb onedir packages

Contributing / dev docs (5)

• #64216 — Update pyenv instructions in CONTRIBUTING guide
• #62498 — "Contributing" page sets unrealistic expectations
• #57203 — docs: "SaltStack git Policy" still references old branching/release model
• #58208 — Add rst/sphinx ".. deprecated::" directive to docs in Deprecating Code guidance
• #63698 — Documentation py renderer needs upgrade

CLI / man pages (2)

• #63109 — salt-key man + docs page inconsistent with --help
• #60677 — Audit and ensure all args listed in $(salt --help) will match with $(man 1 salt)

Returners docs (3)

• #63367 — Improving returner docs
• #62017 — Inconsistent and incomplete documentation around returners
• #39959 — rawfile_json returner doesn't work in any context

Multi-master / HA / cluster docs (4)

• #69882 — 3008.x - Master Cluster Configuration Requires Interface Setting
• #64941 — Document cluster reference implementation(s)
• #64092 — Multiple instances of a single master behind a load balencer
• #63094 — Docs need updated for HA masters and key signing

State module / examples docs (3)

• #68316 — typos in Salt state module 'file' under 'directory' in examples of using clean
• #61587 — The examples of states.ssh_auth use the parameter "names" but this parameter is never explained in the doc
• #61828 — document Module.run usage with pyobjects renderer

Proxy / networking / gitfs docs (2)

• #63069 — No supporting documentation exists for use of http_proxy / https_proxy
• #58929 — Example of per-saltenv gitfs root setting

Misc / small fixes (8)

• #64473 — Improvements to core Salt doc topics requested by VMware customers
• #64291 — Document how to install optional dependencies for Salt
• #57158 — Docs updates around securing salt
• #36962 — doc/topics/development/conventions/formulas.rst ID Naming Standard
• #60607 — Custom winrepo_dir_ng value breaks pkg.refresh_db
• #66639 — Add info in ansible modules about requirements for new ansible-core
• #61768 — Document and test issues with grains on salt-master run as non-root user
• #61769 — Document and test support for @wheel, @runner and @jobs syntax in publisher_acl