saltstack / saltstack/salt

[DOCS] Request channel documented default incorrect

Open
#66,270 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Description
Current documented default timeout is 30 where the actual default timeout in the code base is 60 seconds.

Suggested Fix
Docs just need to be updated to reflect the actual code.

Location or format of documentation
This could be Salt documentation, Salt modules, the Salt Repo or the Getting Started guide.

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 linked Salt minion configuration documentation and locate the request-channel-timeout setting. Update its documented default from 30 to 60 seconds, then check the rendered section to confirm the wording matches the actual default.

Written by the indexing model from the issue text.

Assessment

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.