[JIRA] (JENKINS-58871) Publish API documentation

2019-08-08 Thread djpe...@sandia.gov (JIRA) 
Title: Message Title


 
 
 
 

 
 
 

 
   
 Daniel Peacock commented on  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.  
 

  
 
 
 
 

 
 
 

 
 
 Add Comment  
 

  
 

  
 
 
 
  
 

  
 
 
 
 

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

  
 

   





-- 
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.201190.1565308174000.11092.1565309040058%40Atlassian.JIRA.

[JIRA] (JENKINS-58871) Publish API documentation

2019-08-08 Thread djpe...@sandia.gov (JIRA) 
Title: Message Title


 
 
 
 

 
 
 

 
   
 Daniel Peacock created an issue  
 

  
 
 
 
 

 
 
  
 
 
 
 

 
 Jenkins /  JENKINS-58871  
 
 
  Publish API documentation   
 

  
 
 
 
 

 
Issue Type: 
  Improvement  
 
 
Assignee: 
 Unassigned  
 
 
Components: 
 docker-workflow-plugin  
 
 
Created: 
 2019-08-08 23:49  
 
 
Labels: 
 documentation docker plugin  
 
 
Priority: 
  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: 
 
https://plugins.jenkins.io/docker-workflow 
https://jenkins.io/doc/book/pipeline/docker/ 
https://wiki.jenkins.io/display/JENKINS/Docker+Pipeline+Plugin 
https://github.com/jenkinsci/docker-workflow-plugin/blob/master/README.md 
 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.