Dash / DevDocs docset for Jenkins

[Chris Kilding]

Hello,

Would the community be interested in having a Dash/DevDocs docset for Jenkins? I’d be willing to do the packaging work for this if there is sufficient interest.

For our part, Jenkins admins in my company utilise the Pipeline DSL reference and the JobDSL reference quite heavily - these are the things we’d most like to have in an offline docset.

Chris

PS If you don’t know what Dash or DevDocs are, see https://kapeli.com/dash and https://devdocs.io

[Nik Reiman]

Yes! Big +1 to that idea. I've been wanting to have a docset for the pipeline DSL for awhile now, but I never got around to hacking something together. Such a resource would be much appreciated.

________________________________________
From: jenkin...@googlegroups.com <jenkin...@googlegroups.com> on behalf of Chris Kilding <chris+...@chriskilding.com>
Sent: Wednesday, January 22, 2020 16:42
To: jenkin...@googlegroups.com
Subject: Dash / DevDocs docset for Jenkins

Hello,

Chris

--
You received this message because you are subscribed to the Google Groups "Jenkins Developers" group.
To unsubscribe from this group and stop receiving emails from it, send an email to jenkinsci-de...@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/jenkinsci-dev/120f232d-8cdf-4b52-acc3-4f48bdc172f3%40www.fastmail.com.

[Jesse Glick]

On Wed, Jan 22, 2020 at 10:43 AM Chris Kilding
<chris+...@chriskilding.com> wrote:
> Jenkins admins in my company utilise the Pipeline DSL reference and the JobDSL reference quite heavily - these are the things we’d most like to have in an offline docset.

Not sure offhand about `job-dsl`, but the Pipeline DSL is better
referenced within the product itself, e.g.

https://ci.jenkins.io/pipeline-syntax/

which takes into account the precise versions of installed plugins,
and gives much more information than the static HTML could.

[Chris Kilding]

1. Job DSL is not part of Jenkins core so it would have a separate docset.
2. When we have a Jenkins server to hand we do generally try to use the Pipeline syntax / snippet generator. But sometimes we’re dealing with Jenkins servers that may be behind firewalls - or fixing non-functional servers - such that we can’t use the interactive documentation. Lots of developers also just don’t know about the interactive docs. As a result we still often use the static pipeline docs.

Chris

> --
> You received this message because you are subscribed to the Google
> Groups "Jenkins Developers" group.
> To unsubscribe from this group and stop receiving emails from it, send
> an email to jenkinsci-de...@googlegroups.com.
> To view this discussion on the web visit

> https://groups.google.com/d/msgid/jenkinsci-dev/CANfRfr3aK%2BPPwadfPpDKHHyFLY_F5gqKM%3DiBus9VKyH2U5n3HQ%40mail.gmail.com.
>