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

Generated pipeline steps documentation is too large

    Details

    • Similar Issues:

      Description

      https://jenkins.io/doc/pipeline/steps/workflow-basic-steps/#wrap-general-build-wrapper

      is a whopping 7.3MB of html, which slows down ordinary browsers considerably.

      Seems that something went wrong when generating this:

      There seem to be several issues:

      1. There is one line that is 1.9MB alone, look for

      ${:encoding=>"UTF-8", :interpolate=>false, :scss=>{:line_numbers=>true, :style=>"expanded"}, :sass=>{:line_numbers=>true, :style=>"expanded"}, :content_syntax=>{"coffee"=>"coffeescript"
      ...
      

      seems that someone is prinln-debugging there and printing out a large map/object.

      2. There are 27 steps documented. The documentation between <h3...<code>step</code> and <h3...<code>timeout</code> (which are next to each other), take up 139512 lines, of a total of 139512 (98 percent). If that one step should take up 98% of 7.3 MB, it should probably be on its own page.

        Attachments

          Activity

          Hide
          0x89 Martin Sander added a comment -

          As "step" is very generic, is it possible that it lists every possible step argument, with in turn every possible step recursively, for all plugins available?

          Show
          0x89 Martin Sander added a comment - As "step" is very generic, is it possible that it lists every possible step argument, with in turn every possible step recursively, for all plugins available?

            People

            • Assignee:
              Unassigned
              Reporter:
              0x89 Martin Sander
            • Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

              • Created:
                Updated: