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

jenkins.io - Add Manage Users documentation #5884

Open
kmartens27 opened this issue Jan 6, 2023 · 13 comments · May be fixed by #7923
Open

jenkins.io - Add Manage Users documentation #5884

kmartens27 opened this issue Jan 6, 2023 · 13 comments · May be fixed by #7923
Assignees
Labels
documentation Jenkins documentation, including user and developer docs, solution pages, etc.

Comments

@kmartens27
Copy link
Contributor

kmartens27 commented Jan 6, 2023

Follow up from WEBSITE-426

At this time, the Manage User page is empty and contains no relevant information. This page should either be removed, if other pages provide this information, or updated to have content so that it is not a blank page.

Links

Manage Users page

@kmartens27 kmartens27 added the documentation Jenkins documentation, including user and developer docs, solution pages, etc. label Jan 6, 2023
@BhaswatiRoy
Copy link

Hello @kmartens27
What exactly can be put in that section? Could you please elaborate?

@kmartens27
Copy link
Contributor Author

Hi @BhaswatiRoy, thanks for checking in on this! Essentially, the Manage Users page is currently blank, and it should have information on how to manage users in Jenkins.
Screen Shot 2023-01-18 at 9 23 02 AM

The scope of the page should remain with managing the users:

  • What managing users in Jenkins means
  • Where to do that/how to get there
  • What is necessary to create a user
    Screen Shot 2023-01-18 at 9 23 14 AM
  • What does it mean to configure the user/what can I configure for users
    Screen Shot 2023-01-18 at 9 23 50 AM

There is already a separate page for Managing Security that covers Jenkins authorization/matrix based permissions, so it is good to link to, but not necessary for this page.

@Flamki
Copy link

Flamki commented Jan 20, 2023

I want to work on this issues please assign me this

@BhaswatiRoy
Copy link

BhaswatiRoy commented Jan 20, 2023

Hello @kmartens27
okay then just linking the managing security page would work right?

or does the following need to be included too?

  1. signup
  2. login & logout
  3. configuration of user description
  4. all the points you mentioned
    (and everything is backed up with screenshots to make it easy for users to understand)

I can work on this

@kmartens27
Copy link
Contributor Author

Hi @BhaswatiRoy, in this case the signup and login/logout aspects are not needed. This page would contain information about managing users in Jenkins, which is only possible if you are already logged in and have the necessary permissions. The user description doesn't need to much explanation

When linking to the security page, you could use the direct link to the authorization section.

This is a page that needs a good amount of content, and I'm more than happy to assist in creation/guidance if it becomes too much.

With screenshots, not everything needs one and several things can be contained in a single screenshot, as long it is not cramped. Additionally, be sure to compress the images using something like compressor.io or png crush.

@kmartens27
Copy link
Contributor Author

@Flamki I have assigned this to @BhaswatiRoy, however if you would like to contribute to this ticket, I can also assign you. This is a larger contribution, so collaborating with Bhaswati is an option provided they're okay with that.

@Flamki
Copy link

Flamki commented Jan 21, 2023

ya sure

@BhaswatiRoy
Copy link

Hello @Flamki
Which parts do you plan to do? Let me know then we can plan accordingly

@BhaswatiRoy
Copy link

Hello @kmartens27
For now I came up with this much, would you suggest elaborating any parts/ adding any steps/ describing any steps?
https://github.com/BhaswatiRoy/jenkins.io/blob/master/content/doc/book/managing/users.adoc

@biru-codeastromer
Copy link
Contributor

Hi @kmartens27,
I’d love to contribute to this issue by creating the proper documentation. I noticed that an aspiring contributor was previously assigned, but there hasn’t been any progress, and the referenced PR has been closed. Since the Manage Users page is still blank, I’d be happy to take this up and ensure it gets completed.

I’ve gone through your comments and have a clear understanding of what needs to be covered. However, I’d love to hear any additional recommendations or specific points you’d like me to focus on to ensure the documentation aligns perfectly with your expectations. Looking forward to your response ! 🤗

@kmartens27
Copy link
Contributor Author

Hi @biru-codeastromer, thank you for your enthusiasm. This content would still need to be created, so if you are feeling inclined to do so, please go right ahead! I think we've outlined what should be included here, but on top of what is noted here, it would be good to include that the Jenkins administrator would have the ability to go to the user's account/configuration page and alter any information they might need to, in addition to deleting the user entirely.

Image

@biru-codeastromer
Copy link
Contributor

Hi @kmartens27,
Thank you for the opportunity! I'd love to take this up and ensure the 'Manage Users' page gets the proper documentation it needs.Yesterday I tried to implement the documentation based on what you mentioned here previously in my local .
Based on your latest inputs, I will add these inclusions in that .
Once ready , I will raise the PR for you to have a look how it goes .

@biru-codeastromer
Copy link
Contributor

I do have made a PR #7923 for this . Let me know how you feel about that .

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Jenkins documentation, including user and developer docs, solution pages, etc.
Projects
None yet
4 participants