What suggestions do you have to improve this page? (If you answered "Very helpful" above, feel free to write "None" to indicate no further feedback.)

Are there any other aspects of the Jenkins User Documentation that you'd like to see improved? (Please be as specific as possible.)

it has no actual content. It refers to "this chapter" but then there is no chapter text. It's not helpful at all.

Cmon, guys!
---
timestamps
Prepend all console output generated by the Pipeline run with the time at which the line was emitted. For example: options { timestamps() }
---
this is not true! I tried in a different ways with installed TImestamper plugin - and there is no such option as timestamps()!
Please advise.

https://jenkins.io/doc/tutorials/building-a-node-js-and-react-app-with-npm/

None of the Blueocean tutorial pages will work, as the currently published docker images (specifically the one used in the documentation) will work for the tutorial, as they do not allow dockers to be spawned. Which, when you think about it, is kind of incredible because this means you are 100% guaranteed to fail when trying to complete this tutorial (if you just want to follow the instructions as presented). Additionally, the docker images do not appear to be available in a public repo, which again is kind of incredible.

Otherwise, the documentation is really solid. So disappointing that I've spent over an hour now just trying to find out how I can help fix the problem, but I can't because the simplest procedures haven't been followed to facilitate contributing.

Why does the text "You need to register this public SSH key with your Git server to continue - learn more." link to this page when nothin on the page explains how to register the SSH key. Completely useless

When including config elements like "agent" it would be helpful to see some guidance on what they mean.

The "Using environment variables" page shows the usage of the environment block, but that doesn't work at all. There is no mention of withEnv that actually does work.

node {
stage ('TestNotWorking')
{
environment
{
TESTVAR1 = '1'
}

bat "set"
}

stage ('TestWorking')
{
withEnv( [ 'TESTVAR2=1' ] )
{
bat "set"
}
}
}

Improve documentation with clear separation declarative/non-declarative pipeline and usage of the plugins in declarative/non-declarative way.
I have wasted a lot of time!!!
Would recommend to rethink before choosing Jenkins.

Improve documentation with clear separation declarative/non-declarative pipeline and usage of the plugins in declarative/non-declarative way.
I have wasted a lot of time!!!
Would recommend to rethink before choosing Jenkins.

This page replaced the wiki page but contains less than 50% of the original content. All the definitions of build results were lost, not only from the new glosary but they were also removed from the wiki page which was replaced with a single link pointing to the crippled version.

Maybe bring back the wiki? at least there people could fix and add comments, collaborating on improving it.

The new system is static, the feedback form is opaque and does not help much in going forward.

There is a LOT of documentation in the wiki that appears to be obsolete. I'm noticing that the docker container configuration is NOT what is covered in distributed builds.

This says nothing about HOW this works, where the files ACTUALLY are or anything. It just assumes you're using jUnit and that you want to run jUnit directly from the pipeline. Very unheplful.

https://jenkins.io/doc/tutorials/building-a-node-js-and-react-app-with-npm/

Code examples of how to use the plugin are needed. Also, the field names here do not match the UI elements, so the example is really important for getting things right.

I selected github for my source & selected my repo, job then hung on 'Scan Repository Log' phase, telling me I was connecting to github with no credentials and was hitting the API limit. A little explanation on setting up credentials would be very helpful.

12:08:53 GitHub API Usage: Current quota has 35 remaining (13 over budget). Next quota of 60 in 50 min. Sleeping for 22 min.

12:11:53 GitHub API Usage: Still sleeping, now only 19 min remaining.

Could not complete the steps. Only "Freestyle Project" was available when I tried to add a new item.

When you say "credentials is only available for Declarative Pipeline. For those using Scripted Pipeline, see the documentation for the withCredentials step", provide a link to the documentation for withCredentials

The documentation at page
> https://jenkins.io/doc/pipeline/steps/workflow-scm-step/
is very unhelpful. Due to how the information is formatted, it is almost impossible to use. Indenting and other sectioning techniques would be extremely helpful to see what parameters belong to which objects. With the way it is, all in one column, it's like having to solve a puzzle to get only part of the information this page promises. While I'm all for solving puzzles on the job, it is not the right way to write documentation.

The checkstyle, jacoco and findbugs plugins have all added proper Jenkinsfile descriptors, but none of them are documented on this listing.

Please add an example of a Jenkinsfile which uses the plugin. https://jenkins.io/doc/pipeline/steps/pipeline-githubnotify-step/

Hi Team,

I'd like to suggest the removal of placeholders. It makes the documentation feel unfinished when you happen upon empty pages in an otherwise excellent manual.

This is very important to me -- I'd like to see documentation for a few extremely common items.
1. Running Jenkins through a proxy (NGINX/Apache). This is extremely common. While I have found samples here and there, it would be great if the team provided a more definitive guide.
2. Running NGINX with TLS (HTTPS) and Certs. Jenkins has support, but it's undocumented.
3. More advanced tutorials and best practices for declarative pipelines. I love the tutorials written so far, but having a few that cover scenarios such as parallel stages, parallel steps, and multi-platform builds would be amazing.

I thoroughly enjoy the docs provided so far, they are extremely helpful, but the addition of the items above would really prove helpful for real-world usage.

How do I use this? This is just a reference, but completely lacks context & usage. Even just a simple example would go a long way here.

I want basic information without having to download a tutorial and several programs. I will not be hosting my own jenkins server, nor will I be creating projects or pipelines from scratch.

some sort of information about what jenkins is, and what it does, without having to download lots of things, would be preferable.

how about a diagram showing how a pipeline works and what triggers are and some written explanation rather than downloading programs and tutorials.

Show examples for agents other than docker or at least show a list of what other agents are available.

All your tutorials are too much centered around docker and github. Most of us developers use a git repository in our LAN and a Java application server to perform integration tests (e. g. Arquillian framework). With the pre-pipeline jenkins configuration page creating a jenkins project was rather easy to understand and accomplish. While I see the benefit of pipelines in offering much more freedom I also see the need for much more varied and detailed tutorials in order for people to understand how to use pipelines, e .g.
show us an example for connecting to a remote git repository using ssh as protocol.

huuuge blob of class documentation that doesn't seem releavant, no documentation of what 'libraryRessource' does or how it works.

Formating of parameter documentation is also very user unfriendly - the thing that catches your eye is the variable type (e.g. string) instead of the variable name....

Just more examples, and an alphabetized reference of Jenkins pipeline commands that one would use in a Jenkinsfile, with examples.

This page is much worse that "Unhelpful". It's a an unintelligible mess that gets me supremely pissed off every time I have to look at it. The Jenkins folks ought to be embarrassed about putting it online. I honestly think putting nothing up at all would be better than this.

https://jenkins.io/doc/tutorials/build-a-node-js-and-react-app-with-npm/

https://jenkins.io/doc/tutorials/build-a-node-js-and-react-app-with-npm/

Jenkins never asked me for the unlock, and therefore I never got the admin password, therefore I was unable to create a use account, therefore the page is garbage because it never takes into account the very likely case that something may not go correctly

Assume that sometimes things will not go 100% correct, and give a way to reset everything back so that you have a chance to get your system to a state that the instructions expect

Put down some examples, it's obvious when the only parameter is the url, but how do specify multiple parameters? This doesn't work:

git branch: 'dev' url: '<URL>'

A few examples would show me how to separate the parameters

For the SSH connection mode, how would we pass in a private key explicity to connect ? what flags do we pass in? is it "-s http://localhost:8080 help -ssh -user jenkins -i id_rsa
"

Some info is missing:
https://jenkins.io/doc/pipeline/steps/workflow-cps/#parallel-execute-in-parallel


parallel: Execute in parallel

org.kohsuke.stapler.NoStaplerConstructorException: There’s no @DataBoundConstructor on any constructor of class org.jenkinsci.plugins.workflow.cps.steps.ParallelStep

None of the tutorials work on recent MacOSX running recent Docker for Mac. All fail with the error message

[simple-java-maven-app] Running shell script
sh: can't create /var/jenkins_home/workspace/simple-java-maven-app@tmp/durable-0001f1fc/jenkins-log.txt: nonexistent directory
sh: can't create /var/jenkins_home/workspace/simple-java-maven-app@tmp/durable-0001f1fc/jenkins-result.txt: nonexistent directory

On windows I am getting this error all the time, tried on work pc and home pc as well:

[simplemavenapp] Running shell script

sh: can't create /var/jenkins_home/workspace/simplemavenapp@tmp/durable-820d39ff/jenkins-log.txt: nonexistent directory

sh: can't create /var/jenkins_home/workspace/simplemavenapp@tmp/durable-820d39ff/jenkins-result.txt: nonexistent directory

script returned exit code -2

why dont you have anything helpful for scripted pipeline ?

where is the documentation for using the following ?
githubPush, headRegexFilter, headWildcardFilter, hyperlink, hyperlinkToModels, installSource, jacoco, jdk, jdkInstaller, jgit, jgitapache, jnlp, jobName, junit, label, lastDuration, lastFailure, lastGrantedAuthorities,

The steps reference doesn't render in a way that makes this page easily readable. Its hard to follow what settings are with what objects, especially when looking at nested settings and descriptions. I've tried in Chrome, Firefox, IE, and Opera. It always looks like one flat doc.

It would be nice to see more documentation for the pipeline that looks like the Job DSL API documentation.

https://jenkins.io/doc/tutorials/build-a-node-js-and-react-app-with-npm/

https://jenkins.io/doc/tutorials/build-a-node-js-and-react-app-with-npm/

The first build doesnt work due to this error:

[simple-node-js-react-npm-app] Running shell script

sh: can't create /var/jenkins_home/workspace/simple-node-js-react-npm-app@tmp/durable-39634fe9/jenkins-log.txt: nonexistent directory

sh: can't create /var/jenkins_home/workspace/simple-node-js-react-npm-app@tmp/durable-39634fe9/jenkins-result.txt: nonexistent directory

script returned exit code -2

There are no example of the pipeline plugin implementation, I couldnt form the command seeing the explanation

Running the Docker jenkinsci/blueocean image - the initial login experience is not as described; there is no "unlock" page. You just have to log in as admin with the password in the InitialAdminPassword file as described

Why is your documentation not searchable? I know the terms I'm looking for, I don't know where you've buried it.

Hundreds of meaningless variables listed, not a single concrete example. What does

scm
Nested Choice of Objects $class: AWSCodePipelineSCM name:::
+ Type: String

mean?!?!

So I should write 'checkout scm $class: AWSCodePipelineSCM myname:::'?

Since you insist on your own syntax, perhaps document it? Show some examples? SCM shows literally hundreds of unexplained entries, not one word on usage.

Show how to actually use these things.

A proper explanation of scripted pipeline, complete with examples for all variables & plugins. All the examples explain in declarative, and there's never a simple one-to-one mapping that is easy to understand.

Working with Jenkins pipelines is an exercise in swearing and frustration, trawling Google in the hope that someone somewhere posted enough working snippets to figure out how to do anything.

The generic build step, "step", documented https://jenkins.io/doc/pipeline/steps/workflow-basic-steps/#code-step-code-general-build-step makes the page far too long to navigate.

Why are certain pages like https://jenkins.io/doc/pipeline/steps/workflow-cps/ no longer listed?

Tried it and it doesn't work and I get no errors. Therefore there are either special conditions which are not mentioned here to get this to work or an in-your-face bug which should have been picked up already. If groovy script lines are ignored I need to know about it.

The current documentation is appalling. There is tons of stuff missing. For example the "node" docs do not mention at all that you specify labels as an optional parameter i.e node("linux&&1604") matches nodes that have the linux and 1604 label defined. No new functionality should be released unless the developer has created the documentation page for the item in detail and checked by someone else or it is completely pointless in using the product.

Since this is the first page presenting the graphical UI (at least was for me), I'd like to see some info about "Save" and "Apply", when to use which... and also about best practices in reverting unwanted changes: how to be sure that you are viewing the saved version of the page again.
Thank you.

The steps section(https://jenkins.io/doc/book/pipeline/syntax/#declarative-steps) does not link to the basic steps documentation: https://jenkins.io/doc/pipeline/steps/workflow-basic-steps/

The basic steps documentation (https://jenkins.io/doc/pipeline/steps/workflow-basic-steps/) does not document `sh`. The most information I was able to find about `sh` in the documentation was here: https://jenkins.io/doc/book/pipeline/jenkinsfile/#build

This is an incomprehensible page. I mean the input pipline plugin. It's so long I have no idea where I am in the context of the information. Breaking it up will help a lot.

It generally needs a lot of work.

Hi Guys, there needs to be more actual examples for how to use the (optional parts of) steps.

I commented now because I have not found any nice easy explanation how to use the SLEEP command with any other TimeUnit as Seconds.

cheers!

Please also provide usage examples instead of only abstract syntax reference. Even more important, provide documentation of what the commands actually do.

Please document the possible pipeline steps with
1) all possible options
2) description of the meaning of those options
3) examples.
If you cannot do this quickly, please at least link to the relevant sources, so we don't need to look for those.

Explain limitations of use e.g. evaluated after agent directive, and actually have an example of using an environment variable and not just `printenv`.

At the very, very start of this article, which in every *other* aspect is very helpful, pretty please write what to name the fscking file one is supposed to check in to scm.

It's mentioned in a billion places that it's "a Jenkinsfile", which sounds more like a fileTYPE than a fileNAME.

The first sentence is not clear to me : "This chapter contains topics for typical Jenkins users (of all skill levels) about Jenkins usage which is outside the scope of the core Jenkins features: Pipeline and Blue Ocean." At first I understood that it was about Pipeline and Blue Ocean. Suggestion : rewrite it as "This chapter is addressed to typical Jenkins users (of all skill levels) about Jenkins usage, excepting the two core Jenkins features: Pipeline and Blue Ocean, which are detailed in [link] ."

Add examples for scripted pipeline. Declarative pipelines can not be used when things get even a little more complicated, which is basically always. And since the whole documentation is focused on declarative pipelines only, it is very hard to found out the equivalent syntax for scripted pipelines.

Provide both please.

th page says """navigate to Get Docker at the top of the website to access the Docker download that’s suitable for your platform"""
there is no get docker aat the top of the page!

Organize Information. Structure it hierarchically This page look like a source code dump.
There is no way to recognize, which classes of SCM are avaliable and which options they provide. Honestly, this page is a mess...

The page is missing some documentation. I had to reference the github repository and dig through the source to figure out how to use a custom docker path.
(I had been looking for withTool)

Ability to add a pull request to update the docs, or some such nonsense - or at least provide examples. This site is the only somewhat useful google result outside stack overflow.

Anecdotally, I like PHP documentation. There are user examples, both good and bad, and a voting system. I don't like most Java docs - I would rather just read the source code.

Add _something_ about how to proper document the shared libs.
The only indication is that a txt file should be in the same folder with the same name. But nothing about its format (markup, html, plaint txt) or if we could add groovydoc on the groovy file so it shows on the Help and the GDSL.

I said "Not that helpful", because I had to get help from a colleague in order to even start to follow the tutorial. A tutorial like this should be rock-solid and list all prerequisites and their version numbers required to follow the tutorial so that it works out of the box. I was not able to observe my initial project run/build with the supplied Jenkinsfile. The Jenkinsfile had the line "agent { docker 'node:6.3' }" in it. A colleague helped me by changing that line to: "agent { docker { image 'node:6.3' } }"

This was really helpful in getting started! When you say to commit changes, I think you also want to tell people to push the changes to the repo. Is that right? If I don't do this, I get errors, and I assume, Jenkins has no idea I have committed locally and not pushed.

https://jenkins.io/doc/tutorials/build-a-multibranch-pipeline-project/

These tutorials rock! The person(s) who put them together have clearly gong to a lot of effort to make them bullet-proof. And, I really like how the steps are explained. Great job!

Please add some concrete examples to https://jenkins.io/doc/pipeline/steps/pipeline-input-step/ .

This page glosses over the very real possibility that the post block uses a different workspace from the stage block. The junit task is very likely to not find the xml files because they are in a different workspace.

This issue of different workspaces for different stages (and post) needs to be made more clear. I thought I had read the documentation pretty carefully, but still had to puzzle through this issue.