Update readme content roles description#75
Update readme content roles description#75Komodoro wants to merge 2 commits intojenkinsci:masterfrom
Conversation
A much more informative way to describe the roles being in the README file of the project helping others to understand better what they are selecting instead of just hovering over thje values in the small text box that the plugin has. And since hovering details only show them for a little nick of time this is a much more intuitive approach
AbhyudayaSharma
added
documentation
|
@AbhyudayaSharma maybe this should be in the docs folder. Let me know if this makes more sense. |
AbhyudayaSharma
left a comment
AbhyudayaSharma
left a comment
There was a problem hiding this comment.
@AbhyudayaSharma maybe this should be in the docs folder. Let me know if this makes more sense.
@Komodoro Thanks a lot for the pull request. I would suggest you to please add this information here: https://github.com/jenkins-infra/jenkins.io/blob/master/content/doc/book/security/access-control/permissions.adoc. There are several other plugins like role-strategy and matrix-auth that can make use of this information. Having a shared documentation that can be updated according to changes in Jenkins core would be better. We can then add a link to that page from the docs of this plugin.
You can refer to https://github.com/powerman/asciidoc-cheatsheet#tables for converting the table to asciidoc which is used by Jenkins.io.
|
Also, please ignore the failing build. This is a problem with ci.jenkins.io, not with the pull request. |
|
Sorry... Had some time off from work and I have this on my work PC. |
2 participants
A much more informative way to describe the roles.
This description is available inline of the html while hovering the respective role attribute.
This is not an urgent call but it seems that it is missing from the documentation. I felt an urge to help others by making this available. Using this plugin on a daily basis, and having this properly documented in the README file of the project, the respective table can provide assistance to others understand better what they are selecting instead of just hovering over the values in the small text box that the plugin has. Since hovering details only show info for a little nick of time this is a much more a intuitive approach, as well as it help define strategies to apply this
Probably not a best practice since there could be a lot of places to have this table on, but at least it will help some folks who want to have this documented somehow.