[JENKINS-58871] Publish API documentation

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.

---
Originally reported by djpeaco, imported from: Publish API documentation

• status: Open
  
• priority: Minor
  
• component(s): docker-workflow-plugin
  
• label(s): docker, documentation, plugin
  
• resolution: Unresolved
  
• votes: 0
  
• watchers: 1
  
• imported: 2025-12-07
  

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.