[JIRA] (JENKINS-61982) jenkins..io docs for 'waite' parameter of pipeline 'build' step are incomplete

5 views
Skip to first unread message

mark.earl.waite@gmail.com (JIRA)

unread,
Apr 21, 2020, 12:26:02 AM4/21/20
to jenkinsc...@googlegroups.com
Mark Waite created an issue
 
Jenkins / Bug JENKINS-61982
jenkins..io docs for 'waite' parameter of pipeline 'build' step are incomplete
Issue Type: Bug Bug
Assignee: Unassigned
Attachments: screencapture-mark-pc2-markwaite-net-8080-pipeline-syntax-2020-04-20-22_12_40-edit.png
Components: pipeline-build-step-plugin
Created: 2020-04-21 04:25
Environment: Jenkins 2.222.1. pipeline build step plugin 2.12
Priority: Minor Minor
Reporter: Mark Waite

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 of 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.

Add Comment Add Comment
 
This message was sent by Atlassian Jira (v7.13.12#713012-sha1:6e07c38)
Atlassian logo

mark.earl.waite@gmail.com (JIRA)

unread,
Apr 21, 2020, 12:27:02 AM4/21/20
to jenkinsc...@googlegroups.com
Mark Waite updated an issue
Change By: Mark Waite
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:

!screencapture-mark-pc2-markwaite-net-8080-pipeline-syntax-2020-04-20-22_12_40-edit.png|thumbnail!

When viewed on [jenkins.io|https://jenkins.io/doc/pipeline/steps/pipeline-build-step/#build-build-a-job], the section for parameter {{wait}} is +empty+ of any description.

I assume the reason it is empty
of on https://jenkins.io/ is because the help for the wait parameter is written using groovy rather than html.  Refer to the [source code|https://github.com/jenkinsci/pipeline-build-step-plugin/blob/master/src/main/resources/org/jenkinsci/plugins/workflow/support/steps/build/BuildTriggerStep/help-wait.groovy] 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.

mark.earl.waite@gmail.com (JIRA)

unread,
Apr 21, 2020, 12:27:02 AM4/21/20
to jenkinsc...@googlegroups.com
Mark Waite updated an issue
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:

!screencapture-mark-pc2-markwaite-net-8080-pipeline-syntax-2020-04-20-22_12_40-edit.png|thumbnail!

When viewed on [jenkins.io|https://jenkins.io/doc/pipeline/steps/pipeline-build-step/#build-build-a-job], the section for parameter {{wait}} is + empty + of any description.

I assume the reason it is empty of https://jenkins.io/ is because the help for the wait parameter is written using groovy rather than html.  Refer to the [source code|https://github.com/jenkinsci/pipeline-build-step-plugin/blob/master/src/main/resources/org/jenkinsci/plugins/workflow/support/steps/build/BuildTriggerStep/help-wait.groovy] 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.
Reply all
Reply to author
Forward
0 new messages