I agree wholeheartedly that the online Pipeline Syntax reference inside
your Jenkins controller is the best choice. It presents help for exactly
the current installed plugins and their versions. I recently added a section
to the git plugin documentation <https://plugins.jenkins.io/git/#pipelines>
that encourages Pipeline users to use the Pipeline Syntax Helper. It
seemed more effective to do that than to provide many, many examples of
different options.
The online collection at https://www.jenkins.io/doc/pipeline/steps/
presents the set of all plugins at their latest versions, whether or not
they are installed on your system. That's more information than most
people need and potentially incorrect information unless they are using the
latest plugin version.
The text is collected from the same sources, the plugins themselves. If
you would like a better description of a parameter or a Pipeline step for a
specific plugin, please provide that better text to the plugin maintainers
as a pull request.
We have Documentation office hours twice a week (Monday at 23:00 UTC and
Thursday at 18:00 UTC). We'd be happy to use one of those sessions to show
how to update Pipeline step documentation for a plugin. I've added the
topic to the office hours for next Monday
<https://docs.google.com/document/d/1ygRZnVtoIvuEKpwNeF_oVRVCV5NKcZD1_HMtWlUZguo/edit#>
so that we'll have a recording of the example that others can use as they
propose improvements to Pipeline specific online help for plugins.
Mark Waite
On Tuesday, February 9, 2021 at 8:08:50 AM UTC-7 Jérôme Godbout wrote:
> +1 online pipeline syntax generator. The online documentation is such a
> pain, page too long to scroll, no type or any example, no freaking idea
> what the hell the value shape must be sometime. You kind of need deep
> knowledge of Java/Jenkins Groovy to have a slight idea of what the value
> are or make reference too.
>
>
>
> When you see crap documentation like this, you known the documentation is
> a failure, oh look great I should put a value of string! what value, what
> effect, is it a path or something, go figure, what does the name actually
> does?!? this is pretty bad, I almost always need to find example, the doc
> is useless:
>
> Or the so verbose description of script!
>
> I wish I could make a better pun, but I don’t see anything to add
>
>
>
> Who ever made the documentation layout and descriptions (or if you prefer
> the lack of both) did a poor job. The collapsing on a single page make
> navigation of it a nightmare too. Live search maybe, link to an actual page
> with actual doc for the function/method/options. Take a look at
> Qt/Microsoft C# documentation or many other online. That would actually
> help people. And like the comment above, why is this not online available
> to all?
>
>
>
> My 2 cents about the snippets/doc, you might disagree, but figuring out
> the command should not be the challenge of using a tools.
>
>
>
>
>
> *From:* jenkins...@googlegroups.com *On
> Behalf Of *Jeremy Mordkoff
> *Sent:* February 9, 2021 9:45 AM
> *To:* Jenkins Users
> *Subject:* Permissions to see pipeline syntax
>
>
>
> What permission(s) do I need to grant to a new user in order for them to
> see the pipeline syntax option?
>
>
>
> I am a full admin and I see it.
>
>
>
> They are authenticated but they only have rights to start and stop jobs
> right now. I created a job for them that invokes a JenkinsFile and they are
> busy writing the script. But at the moment they are flying blind since they
> cannot see the pipeline syntax page and the snippet generator.
>
>
>
> Perhaps there is a standalone instance of this function somewhere?
>
> --
> You received this message because you are subscribed to the Google Groups
> "Jenkins Users" group.
> To unsubscribe from this group and stop receiving emails from it, send an
> email to jenkinsci-use...@googlegroups.com.
> To view this discussion on the web visit
> https://groups.google.com/d/msgid/jenkinsci-users/df291aff-7fc6-483e-8158-481168b12a35n%40googlegroups.com
>
> <https://groups.google.com/d/msgid/jenkinsci-users/df291aff-7fc6-483e-8158-481168b12a35n%40googlegroups.com?utm_medium=email_source=footer>
> .
>
--
You received this message because you are subscribed to the Google Groups
"Jenkins Users" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to jenkinsci-users+unsubscr...@googlegroups.com.
To view this discussion on the web visit
https://groups.google.com/d/msgid/jenkinsci-users/eb5ff368-84f8-4045-8336-765944c956dcn%40googlegroups.com.
