[DOCS] Beacons Inotify Example Wrong for Onedir

Open Beginner friendly
#65,019 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
68/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Stale
Tech stack
python
Domain
documentation

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.

Description

documentation

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.

Dominant language
Python
Stars
15.7k
Forks
5.6k
Avg merge
2d 44m
Merged PRs (30d)
80

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.

More from saltstack/salt

All issues in saltstack/salt

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.