[JIRA] (JENKINS-58871) Publish API documentation

0 views
Skip to first unread message

djpeaco@sandia.gov (JIRA)

unread,
Aug 8, 2019, 7:50:03 PM8/8/19
to jenkinsc...@googlegroups.com
Daniel Peacock created an issue
 
Jenkins / Improvement JENKINS-58871
Publish API documentation
Issue Type: Improvement Improvement
Assignee: Unassigned
Components: docker-workflow-plugin
Created: 2019-08-08 23:49
Labels: documentation docker plugin
Priority: Minor Minor
Reporter: Daniel Peacock

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.

Add Comment Add Comment
 
This message was sent by Atlassian Jira (v7.11.2#711002-sha1:fdc329d)

djpeaco@sandia.gov (JIRA)

unread,
Aug 8, 2019, 8:04:02 PM8/8/19
to jenkinsc...@googlegroups.com
Daniel Peacock commented on Improvement JENKINS-58871
 
Re: Publish API documentation

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.

Reply all
Reply to author
Forward
0 new messages