[DOCS] Document event_match_type option for master and minion configuration files
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 15.7k
- Forks
- 5.6k
- Avg merge
- 2d 44m
- Merged PRs (30d)
- 80
Description
Description
This was discovered as part of working on #58112
How is event_match_type used, when listed in the minion and master config files?
Suggested Fix
Define how it is used, and what the available values mean, at least somewhere in the master and minion docs (*.rst files)
- startswith
- endswith
- find
- regex
- fnmatch
Type of documentation
- minion/master configuration files
- Salt Documentation (.rst) for master/minion configuration files
Location or format of documentation
Master:
- https://github.com/saltstack/salt/blob/master/conf/master
- https://github.com/saltstack/salt/blob/master/doc/ref/configuration/master.rst
Minion:
- https://github.com/saltstack/salt/blob/master/conf/minion
- https://github.com/saltstack/salt/blob/master/doc/ref/configuration/minion.rst
Additional context
15:28 $ grep -nr "event_match_type"| grep -v "Binary file"
salt/utils/event.py:450: match_type = self.opts["event_match_type"]
salt/utils/event.py:618: Default is opts['event_match_type'] or 'startswith'
salt/config/__init__.py:438: "event_match_type": str,
salt/config/__init__.py:1225: "event_match_type": "startswith",
salt/config/__init__.py:1469: "event_match_type": "startswith", "event_match_type": "startswith",
Potentially related results come from grep -nr "match_type"
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
Start with salt/utils/event.py, especially the event_match_type references, and compare the defaults in salt/config/init.py. Update doc/ref/configuration/master.rst and doc/ref/configuration/minion.rst to explain how the option is used and what startswith, endswith, find, regex, and fnmatch mean; done means both configuration references are documented.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 35/100