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 - update "Manage Jenkins" screenshots throughout documentation #6089

Open
kmartens27 opened this issue Feb 27, 2023 · 11 comments
Open
Labels
documentation Jenkins documentation, including user and developer docs, solution pages, etc.

Comments

@kmartens27
Copy link
Contributor

When this PR and this PR are merged, the "Manage Jenkins" page will be updated to reflect the simplified names. This means that the current screenshots used throughout the Jenkins documentation will need to be updated.

This also means that the surrounding text would need to be changed accordingly, so that usage such as "Manage Plugins" is updated to "Plugins".

Links

simplification of names

@kmartens27 kmartens27 added the documentation Jenkins documentation, including user and developer docs, solution pages, etc. label Feb 27, 2023
@Amishakumari544
Copy link

Hi @kmartens27 I would like to work on this issue. can you please assign me?

@kmartens27
Copy link
Contributor Author

Hi @Amishakumari544, thanks for being open to working on this! The requisite PRs have not been merged yet, so unfortunately this cannot be worked on prior. Once the changes have been made and Jenkins has been updated, we can definitely work on this!

@Amishakumari544
Copy link

Amishakumari544 commented Feb 27, 2023

yes, the above two PRs are not yet merged. ok then.

@adithyaakrishna
Copy link
Contributor

Hey @kmartens27
Could you please let me know if I can take this issue up? Both of the PRs are approved but not yet merged so I was wondering if I could work on this issue :)

@kmartens27
Copy link
Contributor Author

Hi @adithyaakrishna, the other PRs must be merged before this issue can be worked on. This is not available to test and get screenshots of prior to the PRs being merged.

@shashanksah143
Copy link
Contributor

Hi, @kmartens27 I saw that both the mentioned PRs are merged. Can I work on this issue?

And I have one question related to screenshots.

Question:
How often the name of the screenshot files are getting changed?

I am asking because I am working on the POC for Screenshot Automation for Jenkins Docs which is one of the GSoC projects Ideas. This GSoC project along with taking screenshots should also handle the comparison of images from the current and last releases of Jenkins, and if there is any difference then it will automate the PR for that image.

To compare the screenshot I will have to use their names from the latest and previous versions. So should I also take into consideration of screenshot names getting changed is common while developing the POC?

@kmartens27
Copy link
Contributor Author

Hi @shashanksah143, the PRs have been merged and this will be available with this week's weekly release 2.395
Once the weekly release is available, you would need to download/update so that the updated setting names are available, and then you would be able to update the screenshots.

When updating screenshots, I try to keep the same filename unless it no longer makes sense. For instance, the screenshot on this page should be updated. However, the filename could stay the same in this instance, since it is located specifically in the managing image folder.

If the filename is referring to the text/subject within a screenshot, make sure that this matches. One major point in this scenario is that the image reference must be updated within the text so that it locates the new image.

@shashanksah143
Copy link
Contributor

okay, I got it. Waiting for release 2.395. After that, I will pick this up.

@shashanksah143
Copy link
Contributor

Hi, @kmartens27 I went through the file changes from both the mentioned PRs. Installed Jenkins V: 2.395.
And found out that, a total of 16 screenshots need to be updated. Can I break it into multiple PRs or one single PR will be fine?

@kmartens27
Copy link
Contributor Author

Hi @shashanksah143, multiple PRs would be best in this case. I would make a separate PR for each page that needs updating. Some may have multiple screenshots that need updating, while others may only have 1, but that would keep everything organized and tracked clearly.

@shashanksah143
Copy link
Contributor

shashanksah143 commented Mar 15, 2023

@kmartens27 Sure, then I will create PR for each page separately.

PR addressing screenshot changes for https://www.jenkins.io/doc/book/managing/plugins/
PR: Link

I checked it, working fine in local environment

kmartens27 pushed a commit that referenced this issue Mar 28, 2023
Updated one screenshot present in the using-credentials
[page](https://www.jenkins.io/doc/book/using/using-credentials/) with
the latest version of Jenkins V: 2.396
For more information please refer to this Issue:
#6089
kmartens27 added a commit that referenced this issue Mar 29, 2023
Updated one screenshot present in the `using-agents` [page](
https://www.jenkins.io/doc/book/using/using-agents/) with the latest
version of Jenkins V: 2.396
For more information please refer to this Issue:
#6089

---------

Co-authored-by: Kevin Martens <99040580+kmartens27@users.noreply.github.com>
kmartens27 added a commit that referenced this issue Mar 29, 2023
Updated one screenshot present in the using-jmeter-with-jenkins
[page](https://www.jenkins.io/doc/book/using/using-jmeter-with-jenkins/)
with the latest version of Jenkins V: 2.396
For more information please refer to this Issue:
#6089

---------

Co-authored-by: Kevin Martens <99040580+kmartens27@users.noreply.github.com>
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

No branches or pull requests

4 participants