saltstack / saltstack/salt

[DOCS] network_settings beacon doesn't list dependency.

Open
#61,332 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

docstring-update documentation module doc standards severity-high time-estimate-single-day
Dominant language
Python
Stars
15.7k
Forks
5.6k
Avg merge
2d 44m
Merged PRs (30d)
80

Description

Description
https://docs.saltproject.io/en/latest/ref/beacons/all/salt.beacons.network_settings.html does not list proute2 as a dependency even though it is a dependency.

Suggested Fix
list dependency

Type of documentation
salt beacons

Location or format of documentation
https://docs.saltproject.io/en/latest/ref/beacons/all/salt.beacons.network_settings.html

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.

Research direction

Open the network_settings beacon documentation page linked in the issue and check its dependency section. Add proute2 to the listed dependencies, then review the rendered page or documentation source to confirm the dependency appears clearly. Done means the page accurately lists proute2 as a dependency.

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
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.