Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOCS] Incorrect redis caching requirements #66193

Open
abhi1693 opened this issue Mar 10, 2024 · 1 comment
Open

[DOCS] Incorrect redis caching requirements #66193

abhi1693 opened this issue Mar 10, 2024 · 1 comment
Labels
Documentation Relates to Salt documentation needs-triage

Comments

@abhi1693
Copy link

Description
The docs only mention to install redis package and provides intructions for redis cluster mode. I had to read the source code to understand that I installed the wrong package.

Suggested Fix
Provide additional requirements in the doc: installation of redis-py-cluster

Type of documentation
salt documentation

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

Additional context
https://github.com/saltstack/salt/blob/master/salt/cache/redis_cache.py#L213

Side note: the error message for redis package is wrong in the source code: https://github.com/saltstack/salt/blob/master/salt/cache/redis_cache.py#L211. This should just say Please install the redis package.

@abhi1693 abhi1693 added Documentation Relates to Salt documentation needs-triage labels Mar 10, 2024
Copy link

welcome bot commented Mar 10, 2024

Hi there! Welcome to the Salt Community! Thank you for making your first contribution. We have a lengthy process for issues and PRs. Someone from the Core Team will follow up as soon as possible. In the meantime, here’s some information that may help as you continue your Salt journey.
Please be sure to review our Code of Conduct. Also, check out some of our community resources including:

There are lots of ways to get involved in our community. Every month, there are around a dozen opportunities to meet with other contributors and the Salt Core team and collaborate in real time. The best way to keep track is by subscribing to the Salt Community Events Calendar.
If you have additional questions, email us at saltproject@vmware.com. We’re glad you’ve joined our community and look forward to doing awesome things with you!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Relates to Salt documentation needs-triage
Projects
None yet
Development

No branches or pull requests

1 participant