Details
-
Type:
Improvement
-
Status: To Do (View Workflow)
-
Priority:
Major
-
Resolution: Unresolved
-
Component/s: design
-
Labels:None
-
Similar Issues:
Description
Looking at: https://jenkins.io/doc/pipeline/steps/
In chrome the l
This page is oddly structured and the layout is odd (over indented) and the presentation gives no context on how to use this list. (see attached
Given that people working in pipeline are developing in Groovy/Java we should make this kind of reference look like other Groovy/Java documentation (see https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html) or consider how the JobDSL api reference is presented (https://jenkinsci.github.io/job-dsl-plugin).
Attachments
Issue Links
- is duplicated by
-
WEBSITE-355 Nested references are unreadable with Pipeline step reference
-
- Done
-
The Pipeline step docs generator should be changed such that each 'delegate' (first argument) to the 'step' metastep appears as an individual step.
For example, there'd be a new file for core (which doesn't exist today), and it would list the following "steps":
There'd also be a new file for the JUnit plugin, and it work have the JUnitResultArchiver "step".
All of these would (if I hadn't removed them from output for now) show on workflow-basic-steps doc as variants of 'step' calls, which is where no user would expect to find them. A side effect of the current behavior is also that many plugins implementing basic Pipeline compatibility don't even show up, as they use general 'step' support (possibly with Symbol annotation to make it look nice) to make them work in Pipeline. These should, in the step doc, be elevated to "first class" steps to be easier to discover and read the doc for.