jenkins.io icon indicating copy to clipboard operation
jenkins.io copied to clipboard

New "Update parent POM" page under "Improve a Plugin tutorial" is missing a critical step

Open Minreaux opened this issue 2 years ago • 2 comments
trafficstars

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

As someone new to both Maven, Open source, and Jenkins contributing, I was following the new "Improve a Plugin tutorial" to learn how to contribute to a plugin.

I was using Windows with Visual Studio Code and Powershell setup for Java development, which I setup by following the "Preparing for Plugin Development" page.

When attempting to go through the "Update parent POM" tutorial steps, I was hitting errors when attempting to run the mvn -ntp versions:update-parent command.

It turns out that these errors were because I did not have a properly configured settings.xml file in my C:/Users/<username>/.m2 directory. The only reason I discovered this issue was because of the linked video on the "Update parent POM" tutorial page.

In this video, they describe that we need to create a settings.xml file and they copy some pre-existing file into their directory. To fix my errors, what I had to do was watch that video frame by frame and copy their settings.xml file into my own settings.xml file and then place it in my user .m2 directory.

It would be great if there was a tutorial page that documented the Jenkins version of this settings file, why it is needed, and where it needs to go. This would allow new users like myself to get a copy of that Jenkins settings.xml file and simply copy/paste it. if there already is a page documenting this process on jenkins.io somewhere, I absolutely could not find it.

Something like the "IDE Configuration" page would be very useful.

Thanks!

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

https://www.jenkins.io/doc/developer/tutorial-improve/update-parent-pom/ https://www.jenkins.io/doc/developer/tutorial-improve/ https://www.jenkins.io/doc/developer/development-environment/ide-configuration/

Minreaux avatar Mar 03 '23 22:03 Minreaux

I would like to work on this issue. Can anyone guide from where should i begin?

BlueDragn avatar Mar 18 '23 05:03 BlueDragn

There is ongoing discussion about this in https://github.com/jenkins-infra/jenkins.io/pull/6113

zbynek avatar Mar 18 '23 07:03 zbynek

closing this as #7194 has been merged and the Maven content is now part of the Update parent POM page.

kmartens27 avatar May 01 '24 13:05 kmartens27