saltstack / saltstack/salt

[DOCS] Inconsistent documentation of cloud events

Open
#64,629 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation help-wanted Salt-Cloud severity-medium time-estimate-sprint
Dominant language
Python
Stars
15.7k
Forks
5.6k
Avg merge
2d 44m
Merged PRs (30d)
80

Description

Description
"Salt Master Events" lists 10 cloud events that will be fired, while "Using Salt Cloud with the Event Reactor" lists six.

Suggested Fix
Find out the truth and correct them.

Type of documentation
Salt documentation

Location or format of documentation
https://docs.saltproject.io/en/latest/topics/event/master_events.html#cloud-events
https://docs.saltproject.io/en/latest/topics/cloud/reactor.html#available-events

Additional context
Some of those listed may not actually work: #64628

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

Compare the cloud-event lists in the Salt Master Events and Using Salt Cloud with the Event Reactor documentation sections linked in the issue, then review the related #64628 issue for evidence about which events work. Confirm the accurate set of events and update both lists so they agree with the verified behavior.

Written by the indexing model from the issue text.

Assessment

Domain
cloud, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.