Update UI screenshots in Managing Jenkins documentation

[kmartens27]

Describe your use-case which is not covered by existing documentation.

There are pages in the Using Jenkins section of documentation that have older screenshots of Jenkins' UI. The current screenshots may show either older terminology "manage credentials" vs the current "credentials" or older versions of the UI where icons are full color as opposed to the modernized versions of what now appear. The screenshots may also contain outdated terminology such as "master" or "slave" where the replacements of "controller" and "agent" should be present. Refer to the Inclusive Naming information for additional details on this.

The screenshots would need to follow the guidelines outlined in the Jenkins contributing guide, along with any necessary highlighting/call outs that might be relevant to the screenshot.

If you are interested in working on this, the quickstart tutorials can help get you up to speed and running Jenkins in no time.

Reference any relevant documentation, other materials or issues/pull requests that can be used for inspiration.

Pages that need screenshot updates:

Change System Time Zone - Complete Jenkins CLI In-process Script Approval - completed

[gounthar]

We could leverage the quickstart tutorials to help new contributors get started with minimal inconvenience. This way, they can have the latest LTS version up and running in just minutes, without needing an in-depth knowledge of Jenkins.

[kmartens27]

@gounthar great callout, I'm adding this to the other tickets as well and that should be a huge help to the hacktoberfest participants

[gitclonegaurang]

I am working on this

[kmartens27]

Thanks very much @gitclonegaurang, definitely reach out if you have any questions or roadblocks as you progress!

[gitclonegaurang]

Hi ,

I am working on updating the screenshots for the following pages:

Change System Time Zone: The current documentation mentions: "A user-defined time zone for the account can be set from the configure option in the user settings." However, in the updated versions, it is now found under: User > Account > User Defined Time Zone. Could you confirm if this is the correct change, and how would you prefer this screenshot to be portrayed for better clarity to end users?

Jenkins CLI: I am unsure which screenshot specifically needs to be updated. Could you provide more details on what changes are required here?

In-process Script Approval: I have identified the screenshot that needs updating. Is there anything specific to highlight or emphasize in this screenshot update?

[kmartens27]

Hi @gitclonegaurang, thanks for checking in on these!

For the time zone, that would be the correct update. In terms of what to capture, scrolling to the bottom of the page so that the "User Defined Time Zone" area is in view would be ideal. Additionally, make sure that you click on or select the dropdown so that it is highlighted. I would take a screenshot of the full page and when taking the screenshot, make sure that the path is shown at the top of the page (Dashboard > "User Name" > Account). The dropdown being selected will highlight the relevant information. Additionally, if you can configure it so that your actual name is not being shown here, that would be best. We want to try and protect the identity of user information, so something like "Jenkins Admin" or "Jenkins User" instead of your name would be ideal.

For the Jenkins CLI screenshot, you can actually disregard that one. I noticed the UI does not match the current UI/workflow and added it here. I'm not finding the Public SSH option and believe it may require more specific set-up to get the desired results. I'll need to work on this one/partner with some other folks to figure out what is needed here.

For In-process Script Approval, this would require a pipeline to be set up that needs approval (as described in the documentation). Once the option is available under Security, the screenshot would need to show the updated icons and terminology. Highlighting the option as it currently would be the goal for that. The other screenshots on the page show an older version of the UI and would need to be updated accordingly, but the information within them can remain the same. However, if that is an issue or if you have trouble setting that up in a test pipeline, please reach out!

Definitely let us know if there are any issues or other questions!

[gitclonegaurang]

Hi @kmartens27 I have notw understood all the images to be updated for User Defined Time Zone and also how to create the pipeline for In-Process Screen Approval, I am just having confusion in what to update in the section of Groovy Sandbox where logs are generated (basically the image in red just above the logs).

Thanks

[kmartens27]

Hi @gitclonegaurang, you do not have to replace that screenshot at this time. To generate the logs in a similar way would require use of another plugin. I believe these logs would not necessarily be visible via the command line, so you can disregard that screenshot and move forward with the others. Thanks very much for letting us know!

[yashpal2104]

Is someone working on this issue currently?

[gitclonegaurang]

@yashpal2104 yes