Uploaded image for project: 'Infrastructure'
  1. Infrastructure
  2. INFRA-1053

Generate automated documentation for options/parameters in Declarative Pipeline

    XMLWordPrintable

    Details

    • Similar Issues:

      Description

      We already have tooling for Pipeline steps which generates a zipball that the jenkins.io build process already downloads.

      I think what would be ideal is to have the options and parameters for Declarative generate single asciidoc documents with:

      • Symbol name
      • Description from help text
      • Provided by: Pipeline or <plugin name>
      • Parameters
      • ???

        Attachments

          Issue Links

            Activity

            Hide
            fabiang Fabian Grutschus added a comment -

            So three years later we still don't have all parameters documented. Can we have at least an manual documentation of the parameters please?

            Show
            fabiang Fabian Grutschus added a comment - So three years later we still don't have all parameters documented. Can we have at least an manual documentation of the parameters please?
            Hide
            zackq ZackQ added a comment - - edited

            Would be great for this to work, since declarative pipeline is already deprecating the use of properties

            Show
            zackq ZackQ added a comment - - edited Would be great for this to work, since declarative pipeline is already deprecating the use of properties
            Hide
            harrygg Harry G. added a comment -

            Any news on that?
            As Fabian said:
            >Can we have at least an manual documentation of the parameters please?

            Show
            harrygg Harry G. added a comment - Any news on that? As Fabian said: >Can we have at least an manual documentation of the parameters please?
            Hide
            robross0606 Robert added a comment - - edited

            Seriously, I have wasted hours and hours trying to figure out what the heck the syntax and options are for a variety of plugins and calls in declarative pipelines.  The documentation is horrendously bad across the board.  4 years and counting.

            Show
            robross0606 Robert added a comment - - edited Seriously, I have wasted hours and hours trying to figure out what the heck the syntax and options are for a variety of plugins and calls in declarative pipelines.  The documentation is horrendously bad across the board.  4 years and counting.
            Hide
            bildrulle Lars Berntzon added a comment -

            Ive spend days trying to understand the documentation on how to create gerrit triggered multibranch jobs. Its impossible to find any answer.

             

            Show
            bildrulle Lars Berntzon added a comment - Ive spend days trying to understand the documentation on how to create gerrit triggered multibranch jobs. Its impossible to find any answer.  

              People

              Assignee:
              Unassigned Unassigned
              Reporter:
              rtyler R. Tyler Croy
              Votes:
              42 Vote for this issue
              Watchers:
              40 Start watching this issue

                Dates

                Created:
                Updated: