Skip to content

[DOCS] Salt Cloud documentation overhaul#69558

Draft
dwoz wants to merge 7 commits into
saltstack:3006.xfrom
dwoz:dwoz/docs/salt-cloud-overhaul-3006
Draft

[DOCS] Salt Cloud documentation overhaul#69558
dwoz wants to merge 7 commits into
saltstack:3006.xfrom
dwoz:dwoz/docs/salt-cloud-overhaul-3006

Conversation

@dwoz

@dwoz dwoz commented Jun 25, 2026

Copy link
Copy Markdown
Contributor

Summary

Comprehensive refresh of the Salt Cloud documentation, addressing 9 docs / docs-with-code issues across the cloud driver suite.

Tests

  • tests/pytests/unit/cloud/test_cloud_events_documented.py — scans salt/cloud/clouds/, salt/cloud/__init__.py, and salt/utils/cloud.py for cloud.fire_event tag literals, normalises them, and asserts each appears on the new reference page. Future drivers that introduce a new tag will fail this test until the doc is updated.
  • tests/pytests/unit/cloud/clouds/test_opennebula_options.py, test_ec2_options.py, test_vmware_options.py, test_azurearm_options.py, test_softlayer_options.py — docstring / doc-page tracking tests that hold each driver's user-facing documentation accountable for the runtime behaviour described in the code.

All 516 cloud unit tests pass; sphinx-build -W -b html produces no warnings.

Issues fixed

Branch strategy

3006.x first. Cloud drivers no longer exist on 3008.x / master (the directory was emptied in 3008.0 except for saltify), so the merge-forward bot will carry the changes that still apply forward to 3007.x and stop there. The reactor / events reference pages live in doc/topics/cloud/ which still exists on 3008.x and master; those will follow naturally during merge-forward.

Test plan

  • pytest tests/pytests/unit/cloud/ — 516 passed, 4 skipped
  • sphinx-build -W -b html — clean
  • pre-commit run --files <touched> — clean (auto-format applied)

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