Uploaded image for project: 'Jenkins Website'
  1. Jenkins Website
  2. WEBSITE-185

Improve the presentation/usability of pipeline steps reference

    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

            Activity

            bitwiseman Liam Newman created issue -
            bitwiseman Liam Newman made changes -
            Field Original Value New Value
            Summary Improve the presentation and organization of pipeline reference Improve the presentation/usability of pipeline reference
            bitwiseman Liam Newman made changes -
            Priority Minor [ 4 ] Major [ 3 ]
            rtyler R. Tyler Croy made changes -
            Rank Ranked higher
            rtyler R. Tyler Croy made changes -
            Rank Ranked higher
            rtyler R. Tyler Croy made changes -
            Summary Improve the presentation/usability of pipeline reference Improve the presentation/usability of pipeline steps reference
            rtyler R. Tyler Croy made changes -
            Rank Ranked higher
            rtyler R. Tyler Croy made changes -
            Link This issue is duplicated by WEBSITE-355 [ WEBSITE-355 ]
            kwhetstone Kristin Whetstone made changes -
            Assignee Kristin Whetstone [ kwhetstone ]

              People

              • Assignee:
                kwhetstone Kristin Whetstone
                Reporter:
                bitwiseman Liam Newman
              • Votes:
                0 Vote for this issue
                Watchers:
                3 Start watching this issue

                Dates

                • Created:
                  Updated: