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

Jump to bottom

Salt wheel key documentation improvements #35683

Closed
JensRantil opened this issue Aug 23, 2016 · 3 comments · Fixed by #35824
Closed

Salt wheel key documentation improvements #35683

JensRantil opened this issue Aug 23, 2016 · 3 comments · Fixed by #35824
Assignees
@rallytime
Labels
Core relates to code central or existential to Salt Documentation Relates to Salt documentation Feature new functionality including changes to functionality and code refactors, etc. fixed-pls-verify fix is linked, bug author to confirm fix
Milestone
C 5

Comments

@JensRantil
Copy link
Contributor

Background: I was interested in coding up accepting minion keys. I found https://docs.saltstack.com/en/latest/ref/wheel/all/salt.wheel.key.html, but I wanted to know if my accept went through or not (since there was a risk my key was rejected). I looked at https://github.com/saltstack/salt/blob/develop/salt/wheel/key.py#L49 and discovered that it actually returns a result of some kind. However, the PyDoc doesn't document that.

Proposal: To document the return results on the functions in https://github.com/saltstack/salt/blob/develop/salt/wheel/key.py.
@JensRantil
Copy link
Contributor Author

Looks like it will return something based on this: https://github.com/saltstack/salt/blob/develop/salt/key.py#L606

@Ch3LL
Copy link
Contributor

Ch3LL commented Aug 24, 2016

@JensRantil looking at the documentation here I definitely agree that there can be improvments such as expected returns and examples of each command. I'll approve as a documentation improvement

@Ch3LL Ch3LL added Feature new functionality including changes to functionality and code refactors, etc. Documentation Relates to Salt documentation Core relates to code central or existential to Salt labels Aug 24, 2016
@Ch3LL Ch3LL added this to the Approved milestone Aug 24, 2016
rallytime pushed a commit to rallytime/salt that referenced this issue Aug 26, 2016
Add more documentation to the wheel key module
e5caf6a 
Fixes saltstack#35683
@rallytime rallytime mentioned this issue Aug 26, 2016
Merged
@rallytime
Copy link
Contributor

@JensRantil Please see the update in #35824.

@rallytime rallytime added fixed-pls-verify fix is linked, bug author to confirm fix TEAM Core labels Aug 26, 2016
@rallytime rallytime modified the milestones: C 5, Approved Aug 26, 2016
@rallytime rallytime self-assigned this Aug 26, 2016
rallytime pushed a commit to rallytime/salt that referenced this issue Sep 2, 2016
Add more documentation to the wheel key module
e80b38b 
Fixes saltstack#35683
rallytime pushed a commit that referenced this issue Sep 2, 2016
Back-port #35824 to 2016.3 (#36038)
1d90c42 
* Add more documentation to the wheel key module

Fixes #35683

* Shorten some of the pub/priv key documentation examples.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@rallytime rallytime

Labels
Core relates to code central or existential to Salt Documentation Relates to Salt documentation Feature new functionality including changes to functionality and code refactors, etc. fixed-pls-verify fix is linked, bug author to confirm fix
Projects
None yet
Milestone
C 5
Development

Successfully merging a pull request may close this issue.

Add more documentation to the wheel key module rallytime/salt
3 participants
@JensRantil @rallytime @Ch3LL