Details

    • Similar Issues:

      Description

      This plugin has a nice tutorial, but detailed API documentation would be beneficial. I found at least a start of this in github: help.jelly. That documentation was very helpful to me, explaining the differences between run, withRun, and inside clearly and succinctly.

      Is that jelly file, or other API documentation, been generated and posted anywhere? If so, it should be linked from some or all of these common entry pages to give it more visibility:

      If not, it would be nice to get it published.

      In the short-term, simply linking to that jelly file from the github README would help developers not familiar with the structure of jenkins plugin code to find it more quickly.

        Attachments

          Activity

          Hide
          djpeaco Daniel Peacock added a comment -

          Oh, I should mention I also found this:
          https://jenkins.io/doc/pipeline/steps/docker-workflow/
          which has nice documentation for the top-level methods of the docker object, but doesn't include documentation for other objects like Image.

          Show
          djpeaco Daniel Peacock added a comment - Oh, I should mention I also found this: https://jenkins.io/doc/pipeline/steps/docker-workflow/ which has nice documentation for the top-level methods of the docker object, but doesn't include documentation for other objects like Image.

            People

            • Assignee:
              Unassigned
              Reporter:
              djpeaco Daniel Peacock
            • Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

              • Created:
                Updated: