Uploaded image for project: 'Jenkins'
  1. Jenkins
  2. JENKINS-62223

Many field descriptions of git plugin pipeline docs are empty

    Details

    • Similar Issues:
    • Released As:
      git plugin 4.4.0

      Description

      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

      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.

        Attachments

          Activity

          There are no comments yet on this issue.

            People

            • Assignee:
              markewaite Mark Waite
              Reporter:
              markewaite Mark Waite
            • Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: