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

add Manage Users documentation to "jenkins.io" #7923

Open
wants to merge 16 commits into
base: master
Choose a base branch
from

Conversation

biru-codeastromer
Copy link
Contributor

@biru-codeastromer biru-codeastromer commented Feb 27, 2025

Fixes #5884

Summary

  • This PR resolves issue #5884 by adding comprehensive documentation for the Manage Users page on Jenkins.io. The page was previously empty, and this contribution provides a detailed guide on managing users in Jenkins, including creating, configuring, modifying, and deleting users.

Changes

  • Included step-by-step instructions with screenshots for:
  1. Accessing the Manage Users page.
  2. Creating a new user.
  3. Configuring user settings.
  4. Modifying user information.
  5. Deleting a user.
  6. Added a Troubleshooting section to address common issues.
  7. Linked to the Managing Security documentation for authorization details.

Testing

  • Tested locally using make run to ensure the documentation renders correctly.
  • Verified all links and images are functional.

Please let me know for improvements !

@biru-codeastromer biru-codeastromer requested a review from a team as a code owner February 27, 2025 09:13
@probot-autolabeler probot-autolabeler bot added the documentation Jenkins documentation, including user and developer docs, solution pages, etc. label Feb 27, 2025
@biru-codeastromer biru-codeastromer changed the title Add Manage Users Documentation to Jenkins.io add Manage Users documentation to "jenkins.io" Feb 27, 2025
made both titles to "Users" as it aligned with how now jenkins looks
@biru-codeastromer
Copy link
Contributor Author

biru-codeastromer commented Feb 27, 2025

I changed the title to "Users" instead of "Manage Users" because in our Jenkins , I see that name changed to "Users" . Let me know if I am mistaken about it .

@kmartens27
Copy link
Contributor

that's a good catch @biru-codeastromer since the menu title was changed. Thanks very much. I'll be reviewing this today and will be sure to provide feedback.

@biru-codeastromer
Copy link
Contributor Author

that's a good catch @biru-codeastromer since the menu title was changed. Thanks very much. I'll be reviewing this today and will be sure to provide feedback.

Sure ! Thanks very much for your time and guidance .

Copy link
Contributor

@kmartens27 kmartens27 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks so much for this content @biru-codeastromer. I've provided some smaller suggestions (case, syntax replacement) and alternatives for things like the access control link at the bottom of the page.

I was originally going to include feedback about the "deleting a user" instructions until I realized there were multiple ways to do this. Would it be possible to include the alternative deletion process (going to Manage Jenkins > Users > selecting the trash can icon to the right of the user you want to delete)?

Everything else looks good so far, so thank you again!

@biru-codeastromer
Copy link
Contributor Author

I was originally going to include feedback about the "deleting a user" instructions until I realized there were multiple ways to do this. Would it be possible to include the alternative deletion process (going to Manage Jenkins > Users > selecting the trash can icon to the right of the user you want to delete)?

Sure , I will add that with needed screenshots and push the changes soon and update you here about that after I complete .

Everything else looks good so far, so thank you again!

Welcome and thanks for your feedbacks !

@biru-codeastromer
Copy link
Contributor Author

Hello @kmartens27 I have added the alternative to "delete users" with added screenshot . Thanks !

Sorry for the late .

@zbynek
Copy link
Contributor

zbynek commented Feb 28, 2025

Maybe worth pointing out that Jenkins can use many external systems for user management, you can log in to Jenkins with your GitHub, Gitlab, Google, LDAP, ... account as long as you have the respective plugin configured. Information in this article is only relevant if the internal user database is used.

@biru-codeastromer
Copy link
Contributor Author

Hi ,
That's a great point! I’ll add a note mentioning this .
I'll update the doc shortly .thanks for your suggestion!

applied zbynek suggestion
@biru-codeastromer
Copy link
Contributor Author

I have made the change as requested by you . Let me know how about the position I gave to that note .

@zbynek
Copy link
Contributor

zbynek commented Feb 28, 2025

I would suggest moving the note about other user management systems to the beginning, because it explains what is the scope of the article. If it's moved there, it should not be part of a warning, just a normal paragraph.

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
Development

Successfully merging this pull request may close these issues.

jenkins.io - Add Manage Users documentation
4 participants