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

jenkins.io docs for 'wait' parameter of pipeline 'build' step are incomplete

XMLWordPrintable

    • Icon: Bug Bug
    • Resolution: Unresolved
    • Icon: Minor Minor
    • None
    • Jenkins 2.222.1. pipeline build step plugin 2.12

      The pipeline build step plugin online documentation inside Jenkins is much more detailed in its description of the wait argument. The description of the wait argument in the pipeline syntax includes a full page of details in addition to the description of the wait argument.

      It is not clear to me why that page of details is included for the online help of the wait argument. The detail seems almost unrelated, though possibly it is describing some conditions which might be applied to the wait argument?

      The help page for the wait parameter of the pipeline step build inside a running Jenkins server looks like this:

      When viewed on jenkins.io, the section for parameter wait is empty of any description.

      I assume the reason it is empty on https://jenkins.io/ is because the help for the wait parameter is written using groovy rather than html. Refer to the source code to see the implementation.

      Documentation should more frequently remind users that their Jenkins server is the best reference for pipeline documentation. The documentation that is generated inside their Jenkins server reflects exactly the versions they are running.

            Unassigned Unassigned
            markewaite Mark Waite
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Created:
              Updated: