Uploaded image for project: 'Jenkins'
  1. Jenkins
  2. JENKINS-49171

Jenkins Pipeline Documentation Readability

XMLWordPrintable

    • Icon: Improvement Improvement
    • Resolution: Unresolved
    • Icon: Major Major
    • pipeline
    • None

      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:

            Unassigned Unassigned
            ericnondahl Eric Nondahl
            Votes:
            1 Vote for this issue
            Watchers:
            3 Start watching this issue

              Created:
              Updated: