Skip to content

Conversation

@berviantoleo
Copy link
Contributor

@berviantoleo berviantoleo commented Mar 13, 2025

@berviantoleo berviantoleo requested a review from a team as a code owner March 13, 2025 16:15
@probot-autolabeler probot-autolabeler bot added the documentation Jenkins documentation, including user and developer docs, solution pages, etc. label Mar 13, 2025
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.

It appears that there are chunks of content here that are copied over from the Maven tutorial. For instance, there is a large section of "Create your initial Pipeline as a Jenkinsfile" which reads as though it was copied with only minimal changes made.

Additionally, when forking the sample repository a completely updated Jenkinsfile is included, defeating the purpose of the tutorial. I also don't see a build step in the pipeline overview despite it being included
Screenshot 2025-03-13 at 1 40 19 PM
This is after a clean fork of the original repository and running the Build (without making any changes to the completed jenkinsfile).

The screenshots are far too small to be readable by users and must be more focused so that the content is visible. Right now, I have to zoom in quite a bit to even read what is being displayed.
Screenshot 2025-03-13 at 1 45 08 PM
The capture here is also far too wide on the screen, as there is a ton of blank space to the right of the actual build status information, which is unnecessary.

There may be other changes needed, but these are my initial findings.

@berviantoleo
Copy link
Contributor Author

Thank you. I'll revise the sample repository and the tutorial. I wonder how the better approach for capturing the screenshot.

@kmartens27
Copy link
Contributor

Hi @berviantoleo, for the screenshots, I would recommend resizing the window to a smaller size so that there is not so much blank space on the page. Additionally, if you use a screenshot tool to capture just a section of the screen, instead of the full screen, it will help focus on the content that matters. For instance, the first-build-details screenshot could be more focused on the build details and captured closer to how the artifacts screenshot displays. The thing to keep in mind is that not everyone will be using the same size/resolution monitor and therefore screenshots can change very easily depending on the users hardware.

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 very much @berviantoleo for your work and updates on this. I've provided a couple further suggestions regarding the text/screenshots. Approving pending those updates.

Co-authored-by: Kevin Martens <[email protected]>
@gounthar
Copy link
Contributor

gounthar commented Apr 1, 2025

When this tutorial is nearly ready for merging, we should migrate the code repository to the jenkins-docs organization. It's important to ensure that we link to a repository that is part of the Jenkins project.

Thanks!

@kmartens27
Copy link
Contributor

@gounthar should that happen prior to merge or after the merge has taken place? I want to be sure we make this as easy as possible since we've learned from last time.

@gounthar
Copy link
Contributor

gounthar commented Apr 1, 2025

We can reference Bervianto's repository, but I would prefer to merge this PR after the repository has been migrated. This will ensure that we don't overlook the migration step.

@gounthar
Copy link
Contributor

gounthar commented Apr 2, 2025

@berviantoleo could you please make me an admin/maintainer/co-author/anything that would allow me to migrate your repo to the jenkins-docs organization?
Thanks. 🙏

@berviantoleo
Copy link
Contributor Author

@berviantoleo could you please make me an admin/maintainer/co-author/anything that would allow me to migrate your repo to the jenkins-docs organization? Thanks. 🙏

@gounthar
I think I should use a transfer repository for doing that. Adding a collaborator won't allow migrating the repo.

@gounthar
Copy link
Contributor

gounthar commented Apr 3, 2025

Please go ahead this way, then.

@berviantoleo
Copy link
Contributor Author

Please go ahead this way, then.

I've sent the transfer request.
image

@gounthar
Copy link
Contributor

gounthar commented Apr 3, 2025

Thanks a lot, Bervianto.
Transfer finalized!

@kmartens27 kmartens27 merged commit 82973e7 into jenkins-infra:master Apr 3, 2025
7 checks passed
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.

4 participants