documentation of https://docs.saltstack.com/en/latest/ref/roster/all/salt.roster.sshconfig.html#salt.roster.sshconfig.targets
Open
Nobody has claimed this yet.
Confirmed
doc-rework
documentation
help-wanted
pending-community-assignment
severity-medium
time-estimate-sprint
- Dominant language
- Python
- Stars
- 15.7k
- Forks
- 5.6k
- Avg merge
- 2d 44m
- Merged PRs (30d)
- 80
Description
Description of Issue/Question
The documentation talks about a flat yaml file in /etc/salt/roster instead of ssh_config file in $HOME/.ssh/config:
salt.roster.sshconfig.targets(tgt, tgt_type=u'glob', **kwargs)
Return the targets from the flat yaml file, checks opts for location but defaults to /etc/salt/roster
Setup
n/a
Steps to Reproduce Issue
Versions Report
n/a
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 documentation at the salt.roster.sshconfig.targets URL and compare its description with the SSH config roster behavior described in the issue. Update the text so it refers to the SSH config file rather than a flat YAML roster, then verify the rendered documentation matches the actual entry point.
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
- 45/100