[DOCS] Beacons Inotify Example Wrong for Onedir
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 beacons inotify example, https://docs.saltproject.io/en/latest/topics/beacons/index.html#id2, does not work for onedir setup's since it tells the user to install the system package python-inotify which is the pypi package pyinotify.
Salt actually needs the pyinotify package installed in it's environment, not installed on the system python.
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 beacons inotify example at the linked Salt documentation page and review its package-installation instructions for onedir setups. Update the example to identify pyinotify as the required package in Salt's environment, then verify the rendered documentation no longer directs users to install the system package python-inotify.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 68/100