• Type: Bug
• Resolution: Fixed
• Priority: Minor
• Component/s: git-plugin
• Labels:

  • documentation
  • newbie-friendly
• Environment:

  Git plugin 4.2.2

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

Mark Waite created issue - 2020-05-08 17:23

Mark Waite made changes - 2020-05-08 17:23

Assignee

Original: Mark Waite [ markewaite ]

Mark Waite made changes - 2020-05-08 17:24

Labels

Original: newbie-friendly

New: documentation newbie-friendly

Mark Waite made changes - 2020-07-04 15:37

Assignee

New: Mark Waite [ markewaite ]

Mark Waite made changes - 2020-07-04 15:37

Status

Original: Open [ 1 ]

New: In Progress [ 3 ]

Mark Waite made changes - 2020-07-04 16:35

Remote Link

New: This issue links to "PR 928 - Add online help for several fields (Web Link)" [ 25309 ]

Mark Waite made changes - 2020-07-04 16:35

Status

Original: In Progress [ 3 ]

New: In Review [ 10005 ]

Mark Waite made changes - 2020-07-04 21:28

Released As		New: Git plugin 4.4
Resolution		New: Fixed [ 1 ]
Status	Original: In Review [ 10005 ]	New: Fixed but Unreleased [ 10203 ]

Mark Waite made changes - 2020-07-04 21:29

Description

Original: The online reference documentation for the [Jenkins Pipeline checkout step|https://www.jenkins.io/doc/pipeline/steps/workflow-scm-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|https://github.com/jenkinsci/git-plugin/blob/master/src/main/resources/hudson/plugins/git/extensions/impl/CloneOption/help-reference.html] as an example.

New: The online reference documentation for the [Jenkins Pipeline checkout step|https://www.jenkins.io/doc/pipeline/steps/workflow-scm-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 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|https://github.com/jenkinsci/git-plugin/blob/master/src/main/resources/hudson/plugins/git/extensions/impl/CloneOption/help-reference.html] as an example.

Oleg Nenashev made changes - 2020-07-27 14:03

Link

New: This issue relates to JENKINS-63223 [ JENKINS-63223 ]

Load more newer events