jenkinsci / jenkinsci/docker-workflow-plugin
[JENKINS-59515] Create reference documentation for Docker Workflow plugin
- 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
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
Assessment
This issue has not been assessed yet.