Skip to content

docs: returners, beacons, reactors, mine, Thorium cleanup#69564

Draft
dwoz wants to merge 3 commits into
saltstack:3006.xfrom
dwoz:dwoz/docs/event-subsystem-3006x
Draft

docs: returners, beacons, reactors, mine, Thorium cleanup#69564
dwoz wants to merge 3 commits into
saltstack:3006.xfrom
dwoz:dwoz/docs/event-subsystem-3006x

Conversation

@dwoz

@dwoz dwoz commented Jun 25, 2026

Copy link
Copy Markdown
Contributor

Summary

Documentation cleanup for the event subsystem — returners, beacons, reactors, mine, Thorium. Ten open issues from the docs backlog, addressed at the source files and pinned by unit tests so future drift is loud.

Issues closed

Test plan

  • pytest tests/pytests/unit/thorium/test_documented_examples.py tests/pytests/unit/beacons/test_documented_configs.py — 9 passed locally (3 Thorium SLS YAML parses, 3 Thorium module/function existence checks, 1 inotify example validation, 2 beacon-vs-event.send data dict shape pins).
  • sphinx -W --keep-going -b html clean on a fresh build (no new warnings).
  • sphinx -W --keep-going -b man clean.
  • pre-commit clean across every changed file.

Strategy

Branch matrix: oldest-first (3006.x). Merge-forward to 3007.x, 3008.x, master. Event subsystem interface is stable across all four branches; no code logic changes.

Out of scope

dwoz added 3 commits June 25, 2026 16:27
The reactor docs claimed that beacon-fired events arrive wrapped in
data['data'], but the master's _minion_event handler unwraps each
event before firing it on the bus. Reactors see the beacon payload
directly at data['id']. Document both paths and pin the shapes with
unit tests.

Closes saltstack#61616
Sphinx flagged 'Title underline too short' on the three worked
examples added for saltstack#61921. Shorten the titles so the underline
matches.

Closes saltstack#61921
Issues addressed: saltstack#62017 (returner context table), saltstack#63367 (rolled
into the same returner-context section), saltstack#63693 + saltstack#65019 (inotify
install), saltstack#61332 (network_settings pyroute2 dep), saltstack#47675 (mine.update
in module.run footgun), saltstack#39959 (rawfile_json cache-context note),
saltstack#58130 (hashutil.github_signature quoting note).

Closes saltstack#62017 saltstack#63367 saltstack#63693 saltstack#65019 saltstack#61332 saltstack#47675 saltstack#39959 saltstack#58130
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

test:full Run the full test suite

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant