jenkins.io icon indicating copy to clipboard operation
jenkins.io copied to clipboard

Pipeline Syntax page - Wrong documentation

Open KES777 opened this issue 2 years ago • 7 comments

Problem with the Pipeline Syntax page, source file

Screenshots

image

I see some SO answers refer here, but args does not work =( https://stackoverflow.com/a/46359650/4632019

KES777 avatar May 11 '22 12:05 KES777

But next documentation mentions args but did not provide example:

image

KES777 avatar May 11 '22 12:05 KES777

Thanks for opening this issue ! The « args » are provided to the « docker run » command that starts the container in which the steps are run. But the additionalBuildArgs are the arguments provided to the « docker build » command that preceds the aformentioned « docker run ».

dduportal avatar May 11 '22 13:05 dduportal

Yes, I understand. Just complain that args example does not have something like:

    dockerfile {
        docker ...
        args ...
    }

but first example does not describe about args but have that option at example

KES777 avatar May 11 '22 15:05 KES777

Fair. Are you willing to provide an updated example for the « docker {} » agent case? You can do it directly from your webbrowser by scrolling down on the page and click on « improve this page », which open a text editor directly in github web ui

dduportal avatar May 11 '22 16:05 dduportal

sorry, I am a new user, so can do wrong things. Just point places which I did not understand

KES777 avatar May 11 '22 18:05 KES777

sorry, I am a new user, so can do wrong things. Just point places which I did not understand

No problem, and many thanks for pointing it!

I'm proposing that you author this documentation change for 2 reasons:

  • Your report is legit, make sense and is valuable, so as an Open Source maintainer, I really like to give credit to people's contribution. And you are doing a contribution here: it helps a lot!
  • "you know what you don't know": there is no person best suited than you to propose a change to such a documentation. Most of us, maintainers, are using Jenkins since a long time, so we forgot what it's like to get started. Any line I could write would be bad, while you, with a newcomer eye, have the best feedbacks for improvement!

No worries: if you are not willing to propose the change, or if you do not feel like to do it, then we'll try to do it on our own: in that case we'll still mention you on the pull request, so you can review it and give us guidance! Which solution would be the best to you?

dduportal avatar May 11 '22 18:05 dduportal

If I done my configuration successfully then I try to fix documentation. Currently I stuck

KES777 avatar May 11 '22 19:05 KES777