This issue is archived. You can view it, but you can't modify it. Learn more

ExportXMLWordPrintable

      The readability of jenkins pipeline steps documentation could be significantly improved for new Jenkins pipeline users. In particular, adding visible containers and indenting could help indicate the structure of each documentation page.

      Here's an outside example of nicely designed, readable documentation:

      https://developer.apple.com/documentation/quartzcore/caanimation

      Example of poor readability: in particular it is difficult to see which parameter the "Type: boolean" is applying to:

      https://jenkins.io/doc/pipeline/steps/workflow-basic-steps/#code-stash-code-stash-some-files-to-be-used-later-in-the-build

       

      Example of lack of indenting:

            Assignee:
            Unassigned
            Reporter:
            Eric Nondahl
            Archiver:
            Jenkins Service Account

              Created:
              Updated:
              Archived: