[JIRA] (JENKINS-62223) Many field descriptions of git plugin pipeline docs are empty

mark.earl.waite@gmail.com (JIRA)

unread,

May 8, 2020, 1:24:03 PM5/8/20

to jenkinsc...@googlegroups.com

Mark Waite created an issue

Jenkins /

JENKINS-62223

Many field descriptions of git plugin pipeline docs are empty

Issue Type:	Bug
Assignee:	Mark Waite
Components:	git-plugin
Created:	2020-05-08 17:23
Environment:	Git plugin 4.2.2
Labels:	newbie-friendly
Priority:	Minor
Reporter:	Mark Waite

The online reference documentation for the Jenkins Pipeline checkout step is automatically extracted from released plugin online help pages.

Several of the fields in the GitSCM online documentation include no description. The following fields are examples of fields that should be described so that readers know how to use them:

UserRemoteConfig.credentialsId
CGit.repoUrl
GogsGit.repoUrl
GitSCM.gitTool
GitSCM.extensions.GitLFSPull
GitSCM.extensions.SparseCheckoutPaths.sparseCheckPaths.path

Add help for those fields by following the same naming convention and file placement elsewhere in the plugin. The help files are html files placed in the src/resources directory. See the references option as an example.