jenkinsci / jenkinsci/docker-workflow-plugin

[JENKINS-59515] Create reference documentation for Docker Workflow plugin

Open
#627 0 comments 0 reactions 0 assignees View on GitHub
component:docker-workflow-plugin enhancement imported-jira-issue pipeline priority:minor resolution:unresolved ux
Dominant language
Java
Stars
527
Forks
422
Avg merge
10m
Merged PRs (30d)
1

Description

The Docker Workflow documentation is structured as a tutorial/introduction on how to use the plugin. Because of this finding all the arguments a function can have, and finding all the functions an object has is difficult, if they are all listed in that documentation.

A reference documentation page would greatly help with finding the information needed about how to use the functionality this plugin provides. For example check any of the declarative pipeline steps documentation: https://jenkins.io/doc/pipeline/steps/kubernetes-pipeline-steps/.

---
Originally reported by ovidiub13, imported from: Create reference documentation for Docker Workflow plugin


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

Raw content of original issue

The Docker Workflow documentation is structured as a tutorial/introduction on how to use the plugin. Because of this finding all the arguments a function can have, and finding all the functions an object has is difficult, if they are all listed in that documentation.

A reference documentation page would greatly help with finding the information needed about how to use the functionality this plugin provides. For example check any of the declarative pipeline steps documentation: https://jenkins.io/doc/pipeline/steps/kubernetes-pipeline-steps/.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.