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] Need clarification in autoaccept_grains documentation about only working with strings #63708

Closed
gee456 opened this issue Feb 12, 2023 · 9 comments · Fixed by #65232
Closed
Assignees
Labels
Documentation Relates to Salt documentation good first issue good for someone new to salt help-wanted Community help is needed to resolve this severity-medium 3rd level, incorrect or bad functionality, confusing and lacks a work around time-estimate-single-day

Comments

@gee456
Copy link

gee456 commented Feb 12, 2023

Description
When using autoaccept_grains the documentation does not state that the match will only for for grains that are strings.
It will not work for integers, lists of strings or Booleans as well.

Suggested Fix
Note in documentation that the grain must be a string and give examples.

Here are some grains that wont work that are not custom grains.
efi-secure-boot - it's a Boolean
ipv4 - it's a list
server_id - It's an integer

Type of documentation
Current docs are here (https://docs.saltproject.io/en/latest/topics/tutorials/autoaccept_grains.html)

Location or format of documentation
https://docs.saltproject.io/en/latest/topics/tutorials/autoaccept_grains.html

Additional context

@gee456 gee456 added Documentation Relates to Salt documentation needs-triage labels Feb 12, 2023
@barbaricyawps barbaricyawps added severity-medium 3rd level, incorrect or bad functionality, confusing and lacks a work around time-estimate-single-day help-wanted Community help is needed to resolve this good first issue good for someone new to salt and removed needs-triage labels Feb 13, 2023
@joshmcorreia
Copy link
Contributor

FYI this is related to #61436 (comment)

@BabaYaga1221
Copy link

@gee456 I am interested to resolve this issue. can you give more details about file structure and documentation?

@Tanmoy037
Copy link
Contributor

@barbaricyawps I want to give it a try, please assign this to me.

@barbaricyawps barbaricyawps assigned Tanmoy037 and unassigned Tanmoy037 Apr 10, 2023
@barbaricyawps
Copy link
Contributor

I would assign you @Tanmoy037 , but it looks like @BabaYaga1221 would like to work on the issue as well. Who should take it? Let me know and I'll assign one of you.

@BabaYaga1221
Copy link

@barbaricyawps We both will appreciate working on this issue. Please, provide related information and file structure, after that whosoever gives PR first, can close others.

@barbaricyawps
Copy link
Contributor

barbaricyawps commented Apr 10, 2023

I think it's a good practice to get used to the file structure yourself and see if you can map what you see on the web with where it is in the codebase. Let me give a hint:

  • For modules: salt > salt
  • For regular topics: doc > topics

If that hint isn't helpful enough, let me know and I'll give more.

@Tanmoy037
Copy link
Contributor

Thank you @barbaricyawps we will try to figure it out.

Tanmoy037 added a commit to Tanmoy037/salt that referenced this issue May 6, 2023
Tanmoy037 added a commit to Tanmoy037/salt that referenced this issue May 6, 2023
@Tanmoy037
Copy link
Contributor

@barbaricyawps This issue will not fix with doc change, it's a bug I'm working on it please assign it to me.

@barbaricyawps
Copy link
Contributor

@Tanmoy037 , I've assigned you. Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Relates to Salt documentation good first issue good for someone new to salt help-wanted Community help is needed to resolve this severity-medium 3rd level, incorrect or bad functionality, confusing and lacks a work around time-estimate-single-day
Projects
None yet
5 participants