[DOCS] Document that cron and splay are supported together
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 15.7k
- Forks
- 5.6k
- Avg merge
- 2d 44m
- Merged PRs (30d)
- 80
Description
Description
Document that scheduling jobs with both cron and splay is supported/works.
Right now I had to find this issue to check if it was supported as none of the examples show it https://github.com/saltstack/salt/issues/44583
Location or format of documentation
https://docs.saltproject.io/en/latest/ref/states/all/salt.states.schedule.html
Additional context
Would be nice if it was also recommended to use this as otherwise you get very hard to figure out errors like Data failed to compile job is running as PID xxx and a jid which shows nothing. Basically if you have overlapping schedules then one of the jobs will fail to run with a very hard to diagnose error.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Open the referenced schedule documentation page and review how cron and splay are currently described and exemplified. Add a clear note or example covering their combined use, including the scheduling-overlap warning requested in the issue. Done when the page explicitly documents support and gives readers enough guidance to avoid the reported confusing failures.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 55/100