Generated steps documentation

Ullrich Hafner

unread,

Oct 30, 2018, 6:59:37 AM10/30/18

to Jenkins Developers

How is the pipeline steps reference at https://jenkins.io/doc/pipeline/steps/ generated? Would it be possible to list not only the property names but also the descriptions? (From JavaDoc or jelly?)

signature.asc

Daniel Beck

unread,

Oct 30, 2018, 7:00:28 AM10/30/18

to jenkin...@googlegroups.com

> On 30. Oct 2018, at 11:59, Ullrich Hafner <ullrich...@gmail.com> wrote:
>
> How is the pipeline steps reference at https://jenkins.io/doc/pipeline/steps/ generated?

You really don't want to know. Click at your own risk:

https://github.com/jenkins-infra/pipeline-steps-doc-generator

Jesse Glick

unread,

Oct 30, 2018, 10:10:54 AM10/30/18

to jenkin...@googlegroups.com

On Tue, Oct 30, 2018 at 6:59 AM Ullrich Hafner <ullrich...@gmail.com> wrote:
> Would it be possible to list not only the property names but also the descriptions?

So long as your property has a `help-<FIELDNAME>.html` in the usual
databinding style, it should be displayed automatically.

Reply all

Reply to author

Forward