[JIRA] (JENKINS-62223) Many field descriptions of git plugin pipeline docs are empty
Title: Message Title Mark Waite updated an issue Jenkins / JENKINS-62223 Many field descriptions of git plugin pipeline docs are empty Change By: Mark Waite Labels: documentation newbie-friendly Add Comment This message was sent by Atlassian Jira (v7.13.12#713012-sha1:6e07c38) -- You received this message because you are subscribed to the Google Groups "Jenkins Issues" group. To unsubscribe from this group and stop receiving emails from it, send an email to jenkinsci-issues+unsubscr...@googlegroups.com. To view this discussion on the web visit https://groups.google.com/d/msgid/jenkinsci-issues/JIRA.206157.1588958601000.23806.1588958700057%40Atlassian.JIRA.
[JIRA] (JENKINS-62223) Many field descriptions of git plugin pipeline docs are empty
Title: Message Title Mark Waite assigned an issue to Unassigned Jenkins / JENKINS-62223 Many field descriptions of git plugin pipeline docs are empty Change By: Mark Waite Assignee: Mark Waite Add Comment This message was sent by Atlassian Jira (v7.13.12#713012-sha1:6e07c38) -- You received this message because you are subscribed to the Google Groups "Jenkins Issues" group. To unsubscribe from this group and stop receiving emails from it, send an email to jenkinsci-issues+unsubscr...@googlegroups.com. To view this discussion on the web visit https://groups.google.com/d/msgid/jenkinsci-issues/JIRA.206157.1588958601000.23805.1588958640214%40Atlassian.JIRA.
[JIRA] (JENKINS-62223) Many field descriptions of git plugin pipeline docs are empty
Title: Message Title 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.
