[JENKINS-65287] Add an online missing help

[Onyimatics]

• Make sure you are opening from a topic/feature/bugfix branch (right side) and not your master branch!

• Ensure that the pull request title represents the desired changelog entry

• Please describe what you did

• Created help-changelog.html file to add a description of the scm step argument changelog

• Created help-poll.html file to add a description of the scm step argument poll

• Link to relevant issues in GitHub or Jira

• JENKINS-65287
  @MarkEWaite @oleg-nenashev

[MarkEWaite]

Thanks @Onyimatics and congratulations on submitting the first pull request from the SheCodeAfrica Contributhon.

I think that the help for the SCM step is better covered by the existing help that is stored in a "jelly" file. To learn more about how jelly files are used in Jenkins, refer to Jelly form controls.

I believe that one of the two changes is being replaced by the jelly file and the other is appearing but the help from the jelly file is the better choice in that location.

Could you follow that same pattern and add a help file for the polling and changelog checkboxes? I believe that the file names for the help are derived from the names of the variables in Jenkins.

[MarkEWaite]

@Onyimatics the idea I suggested to add online help for the "Include in polling?" item is available at MarkEWaite@c1f434a . I'm not 100% confident on the phrasing, but it matches with the variable name poll . You should be able to confirm it is visible from both the snippet generator and the online help.

A similar file would need to be added for changelog.

[Onyimatics]

Thanks @MarkEWaite for your feedback. I'm really happy I successfully raised a PR.

This is the view from my end which showed me a help icon for checkout and then I added one for SCM. I'm wondering why it's double on your end.

And this is how it looks like on the Snippet Generator Reference Page.

However, I've taken your feedback, I will go ahead and discard the changes, and create the polling and changelog checkboxes using jelly file like you said.

Thanks so much.

[Onyimatics]

@Onyimatics the idea I suggested to add online help for the "Include in polling?" item is available at MarkEWaite@c1f434a . I'm not 100% confident on the phrasing, but it matches with the variable name poll . You should be able to confirm it is visible from both the snippet generator and the online help.

A similar file would need to be added for changelog.

Alright @MarkEWaite
That's well noted. Thanks.

[MarkEWaite]

Thanks for the comparison screenshot. I'm not sure what's different between your version and mine. I'm running the Google Chrome browser on Linux with Jenkins 2.277.1. As far as I can tell, you're running Jenkins 2.277.1 as well. I assume you're using macOS and Safari.

[Onyimatics]

I'm actually using macOS and Google Chrome Browser.
I don't enjoy Safari Browser 😄

[StackScribe]

Suggested change

	This is a special step that will checkout using the configuration options offered by any Pipeline-compatible SCM plugin.
	This is a special step that checks out the code using the configuration options offered by any Pipeline-compatible SCM plugin.

We prefer present tense to future in a case like this.
The proper verb for is "check out" rather than "checkout" and it needs an object

[Onyimatics]

Alright, @StackScribe that's well noted.
Thanks for the correction.

[MarkEWaite]

@Onyimatics you can use the "Commit suggestion" to apply changes that others have suggested.

[Onyimatics]

@MarkEWaite Thanks, well noted.

[dwnusbaum]

Does this existing help file not show up in the UI anywhere? Maybe a bug with how SCMStep is abstract and GenericSCMStep is the concrete implementation?

[MarkEWaite]

Does this existing help file not show up in the UI anywhere? Maybe a bug with how SCMStep is abstract and GenericSCMStep is the concrete implementation?

That help file is visible in the user interface. It is one of the '?' icons in the two that are shown in my screenshot.

[MarkEWaite]

I've confirmed that the text is displayed in Jenkins both from the snippet generator and from the steps reference inside Jenkins.

Needs corrections to the "Include in changelog" description, since it is different than the polling setting.

Thanks very much!

[Onyimatics]

I've confirmed that the text is displayed in Jenkins both from the snippet generator and from the steps reference inside Jenkins.

Needs corrections to the "Include in changelog" description, since it is different than the polling setting.

Thanks very much!

Thanks a lot for the correction.

[MarkEWaite]

I've deployed a pre-release build in my test instance and verified it works as expected.