[DOCS] the an image in master_job_cache description shows an impossible config
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 15.7k
- Forks
- 5.6k
- Avg merge
- 2d 44m
- Merged PRs (30d)
- 80
Description
Description
the image at https://docs.saltproject.io/en/latest/topics/jobs/external_cache.html#master-job-cache-master-side-returner shows syslog being used as a master_job_cache. however because it is not possable to send and recive data from syslog as you would a database, syslog is not possable to be used as a master_job_cache.
The returner function for syslog also does not have the required functions for master_job_cache.
Suggested Fix
remove syslog from the list in the master_job_cache picture.
Type of documentation
image fix
Location or format of documentation
https://docs.saltproject.io/en/latest/topics/jobs/external_cache.html#master-job-cache-master-side-returner
Additional context
https://docs.saltproject.io/en/latest/_images/master-job-cache.png
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 external cache documentation at the linked master_job_cache section and inspect the referenced master-job-cache.png image. Remove syslog from the master_job_cache list, then verify the rendered documentation no longer presents it as a supported option.
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
- 45/100