Permissions to see pipeline syntax

Previous Topic Next Topic
 
classic Classic list List threaded Threaded
8 messages Options
Reply | Threaded
Open this post in threaded view
|

Permissions to see pipeline syntax

jeremy mordkoff
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 [hidden email].
To view this discussion on the web visit https://groups.google.com/d/msgid/jenkinsci-users/df291aff-7fc6-483e-8158-481168b12a35n%40googlegroups.com.
Reply | Threaded
Open this post in threaded view
|

RE: Permissions to see pipeline syntax

Jérôme Godbout

+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: [hidden email] <[hidden email]> On Behalf Of Jeremy Mordkoff
Sent: February 9, 2021 9:45 AM
To: Jenkins Users <[hidden email]>
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 [hidden email].
To view this discussion on the web visit https://groups.google.com/d/msgid/jenkinsci-users/df291aff-7fc6-483e-8158-481168b12a35n%40googlegroups.com.

--
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 [hidden email].
To view this discussion on the web visit https://groups.google.com/d/msgid/jenkinsci-users/QB1PR01MB38444D01A584646FAF10CA31CD8E9%40QB1PR01MB3844.CANPRD01.PROD.OUTLOOK.COM.
Reply | Threaded
Open this post in threaded view
|

Re: Permissions to see pipeline syntax

Mark Waite-2
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 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 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: [hidden email] <[hidden email]> On Behalf Of Jeremy Mordkoff
Sent: February 9, 2021 9:45 AM
To: Jenkins Users <[hidden email]>
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 [hidden email].
To view this discussion on the web visit https://groups.google.com/d/msgid/jenkinsci-users/df291aff-7fc6-483e-8158-481168b12a35n%40googlegroups.com.

--
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 [hidden email].
To view this discussion on the web visit https://groups.google.com/d/msgid/jenkinsci-users/eb5ff368-84f8-4045-8336-765944c956dcn%40googlegroups.com.
Reply | Threaded
Open this post in threaded view
|

Re: Permissions to see pipeline syntax

jeremy mordkoff
This is all well and good, but does not answer my question. 

I can see http://jenkins2.eng.riftio.com/job/build-ext-package/pipeline-syntax/ to view the Pipeline syntax page, but I am a full admin 

Other users cannot see this page (404 errors). Can I enable them to see this page without making them a full admin? They are currently in group "jenkins-users" 



---
Jeremy Mordkoff

Director of Engineering Services
  RIFT, Inc
1.978.257.2183 (cell)

From: [hidden email] <[hidden email]> on behalf of Mark Waite <[hidden email]>
Sent: Tuesday, February 9, 2021 1:47 PM
To: Jenkins Users <[hidden email]>
Subject: Re: Permissions to see pipeline syntax
 
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 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 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...@... <jenkins...@...> On Behalf Of Jeremy Mordkoff
Sent: February 9, 2021 9:45 AM
To: Jenkins Users <jenkins...@...>
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...@....
To view this discussion on the web visit https://groups.google.com/d/msgid/jenkinsci-users/df291aff-7fc6-483e-8158-481168b12a35n%40googlegroups.com.

--
You received this message because you are subscribed to a topic in the Google Groups "Jenkins Users" group.
To unsubscribe from this topic, visit https://groups.google.com/d/topic/jenkinsci-users/E6AF3SnV9A0/unsubscribe.
To unsubscribe from this group and all its topics, send an email to [hidden email].
To view this discussion on the web visit https://groups.google.com/d/msgid/jenkinsci-users/eb5ff368-84f8-4045-8336-765944c956dcn%40googlegroups.com.

--
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 [hidden email].
To view this discussion on the web visit https://groups.google.com/d/msgid/jenkinsci-users/MN2PR18MB2768CD52D3A8A438D35B2D9C888E9%40MN2PR18MB2768.namprd18.prod.outlook.com.
Reply | Threaded
Open this post in threaded view
|

Re: Permissions to see pipeline syntax

Mark Waite-2


On Tue, Feb 9, 2021 at 11:58 AM Jeremy Mordkoff <[hidden email]> wrote:
This is all well and good, but does not answer my question. 


I don't know the answer to your question.

Mark Waite
 
I can see http://jenkins2.eng.riftio.com/job/build-ext-package/pipeline-syntax/ to view the Pipeline syntax page, but I am a full admin 

Other users cannot see this page (404 errors). Can I enable them to see this page without making them a full admin? They are currently in group "jenkins-users" 



---
Jeremy Mordkoff

Director of Engineering Services
  RIFT, Inc
1.978.257.2183 (cell)

From: [hidden email] <[hidden email]> on behalf of Mark Waite <[hidden email]>
Sent: Tuesday, February 9, 2021 1:47 PM
To: Jenkins Users <[hidden email]>
Subject: Re: Permissions to see pipeline syntax
 
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 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 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: [hidden email] <[hidden email]> On Behalf Of Jeremy Mordkoff
Sent: February 9, 2021 9:45 AM
To: Jenkins Users <[hidden email]>
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 [hidden email].
To view this discussion on the web visit https://groups.google.com/d/msgid/jenkinsci-users/df291aff-7fc6-483e-8158-481168b12a35n%40googlegroups.com.

--
You received this message because you are subscribed to a topic in the Google Groups "Jenkins Users" group.
To unsubscribe from this topic, visit https://groups.google.com/d/topic/jenkinsci-users/E6AF3SnV9A0/unsubscribe.
To unsubscribe from this group and all its topics, send an email to [hidden email].
To view this discussion on the web visit https://groups.google.com/d/msgid/jenkinsci-users/eb5ff368-84f8-4045-8336-765944c956dcn%40googlegroups.com.

--
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 [hidden email].
To view this discussion on the web visit https://groups.google.com/d/msgid/jenkinsci-users/MN2PR18MB2768CD52D3A8A438D35B2D9C888E9%40MN2PR18MB2768.namprd18.prod.outlook.com.

--
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 [hidden email].
To view this discussion on the web visit https://groups.google.com/d/msgid/jenkinsci-users/CAO49JtHA7AG%2BT3jKZ3S3ZAQxx1kMSTSXMyRq%3DcvMFzXpWWOhbQ%40mail.gmail.com.
Reply | Threaded
Open this post in threaded view
|

Re: Permissions to see pipeline syntax

Ashish Sharma-2
Hi Jeremy,

Do you see "Extended Read" option, that is the one to allow users to see pipeline config in read only mode. If you are not seeing it, either your jenkins or plugin versions needs update.
Please let me know how this goes, thanks. Ashish

On Wednesday, February 10, 2021 at 3:46:39 AM UTC+8 Mark Waite wrote:
On Tue, Feb 9, 2021 at 11:58 AM Jeremy Mordkoff <jeremy....@...> wrote:
This is all well and good, but does not answer my question. 


I don't know the answer to your question.

Mark Waite
 
I can see http://jenkins2.eng.riftio.com/job/build-ext-package/pipeline-syntax/ to view the Pipeline syntax page, but I am a full admin 

Other users cannot see this page (404 errors). Can I enable them to see this page without making them a full admin? They are currently in group "jenkins-users" 



---
Jeremy Mordkoff

Director of Engineering Services
  RIFT, Inc
<a href="tel:(978)%20257-2183" value="+19782572183" target="_blank" rel="nofollow">1.978.257.2183 (cell)

From: jenkins...@... <jenkins...@...> on behalf of Mark Waite <mark.ea...@...>
Sent: Tuesday, February 9, 2021 1:47 PM
To: Jenkins Users <jenkins...@...>
Subject: Re: Permissions to see pipeline syntax
 
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 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 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: [hidden email] <[hidden email]> On Behalf Of Jeremy Mordkoff
Sent: February 9, 2021 9:45 AM
To: Jenkins Users <[hidden email]>
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 [hidden email].
To view this discussion on the web visit https://groups.google.com/d/msgid/jenkinsci-users/df291aff-7fc6-483e-8158-481168b12a35n%40googlegroups.com.

--
You received this message because you are subscribed to a topic in the Google Groups "Jenkins Users" group.
To unsubscribe from this topic, visit https://groups.google.com/d/topic/jenkinsci-users/E6AF3SnV9A0/unsubscribe.
To unsubscribe from this group and all its topics, send an email to jenkinsci-use...@....
To view this discussion on the web visit https://groups.google.com/d/msgid/jenkinsci-users/eb5ff368-84f8-4045-8336-765944c956dcn%40googlegroups.com.

--
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...@....

--
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 [hidden email].
To view this discussion on the web visit https://groups.google.com/d/msgid/jenkinsci-users/fbaf237e-9073-4150-91ec-38221bce85e8n%40googlegroups.com.
Reply | Threaded
Open this post in threaded view
|

Re: Permissions to see pipeline syntax

jeremy mordkoff
Hmm.. I don't see "extended read" I upgraded everything about 10 days ago. Jenkins 2.277 we are using matrix-based security. Do I need to switch to project-based? 




---
Jeremy Mordkoff

Director of Engineering Services
  RIFT, Inc
1.978.257.2183 (cell)

From: [hidden email] <[hidden email]> on behalf of Ashish Sharma <[hidden email]>
Sent: Wednesday, February 10, 2021 3:56 AM
To: Jenkins Users <[hidden email]>
Subject: Re: Permissions to see pipeline syntax
 
Hi Jeremy,

Do you see "Extended Read" option, that is the one to allow users to see pipeline config in read only mode. If you are not seeing it, either your jenkins or plugin versions needs update.
Please let me know how this goes, thanks. Ashish

On Wednesday, February 10, 2021 at 3:46:39 AM UTC+8 Mark Waite wrote:
On Tue, Feb 9, 2021 at 11:58 AM Jeremy Mordkoff <jeremy....@...> wrote:
This is all well and good, but does not answer my question. 


I don't know the answer to your question.

Mark Waite
 
I can see http://jenkins2.eng.riftio.com/job/build-ext-package/pipeline-syntax/ to view the Pipeline syntax page, but I am a full admin 

Other users cannot see this page (404 errors). Can I enable them to see this page without making them a full admin? They are currently in group "jenkins-users" 



---
Jeremy Mordkoff

Director of Engineering Services
  RIFT, Inc
<a href="tel:(978)%20257-2183" value="+19782572183" target="_blank" rel="nofollow">1.978.257.2183 (cell)

From: jenkins...@... <jenkins...@...> on behalf of Mark Waite <mark.ea...@...>
Sent: Tuesday, February 9, 2021 1:47 PM
To: Jenkins Users <jenkins...@...>
Subject: Re: Permissions to see pipeline syntax
 
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 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 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: [hidden email] <[hidden email]> On Behalf Of Jeremy Mordkoff
Sent: February 9, 2021 9:45 AM
To: Jenkins Users <[hidden email]>
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 [hidden email].
To view this discussion on the web visit https://groups.google.com/d/msgid/jenkinsci-users/df291aff-7fc6-483e-8158-481168b12a35n%40googlegroups.com.

--
You received this message because you are subscribed to a topic in the Google Groups "Jenkins Users" group.
To unsubscribe from this topic, visit https://groups.google.com/d/topic/jenkinsci-users/E6AF3SnV9A0/unsubscribe.
To unsubscribe from this group and all its topics, send an email to jenkinsci-use...@....
To view this discussion on the web visit https://groups.google.com/d/msgid/jenkinsci-users/eb5ff368-84f8-4045-8336-765944c956dcn%40googlegroups.com.

--
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...@....

--
You received this message because you are subscribed to a topic in the Google Groups "Jenkins Users" group.
To unsubscribe from this topic, visit https://groups.google.com/d/topic/jenkinsci-users/E6AF3SnV9A0/unsubscribe.
To unsubscribe from this group and all its topics, send an email to [hidden email].
To view this discussion on the web visit https://groups.google.com/d/msgid/jenkinsci-users/fbaf237e-9073-4150-91ec-38221bce85e8n%40googlegroups.com.

--
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 [hidden email].
To view this discussion on the web visit https://groups.google.com/d/msgid/jenkinsci-users/MN2PR18MB27681A396E4BB041A987EDEF888D9%40MN2PR18MB2768.namprd18.prod.outlook.com.
Reply | Threaded
Open this post in threaded view
|

Re: Permissions to see pipeline syntax

Mark Waite-2
You may need the extended read permission plugin https://plugins.jenkins.io/extended-read-permission/

https://www.jenkins.io/blog/2020/05/25/read-only-jenkins-announcement/ announced the capability and provide a good introduction.

On Wed, Feb 10, 2021 at 8:26 AM Jeremy Mordkoff <[hidden email]> wrote:
Hmm.. I don't see "extended read" I upgraded everything about 10 days ago. Jenkins 2.277 we are using matrix-based security. Do I need to switch to project-based? 




---
Jeremy Mordkoff

Director of Engineering Services
  RIFT, Inc
1.978.257.2183 (cell)

From: [hidden email] <[hidden email]> on behalf of Ashish Sharma <[hidden email]>
Sent: Wednesday, February 10, 2021 3:56 AM
To: Jenkins Users <[hidden email]>
Subject: Re: Permissions to see pipeline syntax
 
Hi Jeremy,

Do you see "Extended Read" option, that is the one to allow users to see pipeline config in read only mode. If you are not seeing it, either your jenkins or plugin versions needs update.
Please let me know how this goes, thanks. Ashish

On Wednesday, February 10, 2021 at 3:46:39 AM UTC+8 Mark Waite wrote:
On Tue, Feb 9, 2021 at 11:58 AM Jeremy Mordkoff <[hidden email]> wrote:
This is all well and good, but does not answer my question. 


I don't know the answer to your question.

Mark Waite
 
I can see http://jenkins2.eng.riftio.com/job/build-ext-package/pipeline-syntax/ to view the Pipeline syntax page, but I am a full admin 

Other users cannot see this page (404 errors). Can I enable them to see this page without making them a full admin? They are currently in group "jenkins-users" 



---
Jeremy Mordkoff

Director of Engineering Services
  RIFT, Inc
<a href="tel:(978)%20257-2183" value="+19782572183" rel="nofollow" target="_blank">1.978.257.2183 (cell)

From: [hidden email] <[hidden email]> on behalf of Mark Waite <[hidden email]>
Sent: Tuesday, February 9, 2021 1:47 PM
To: Jenkins Users <[hidden email]>
Subject: Re: Permissions to see pipeline syntax
 
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 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 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: [hidden email] <[hidden email]> On Behalf Of Jeremy Mordkoff
Sent: February 9, 2021 9:45 AM
To: Jenkins Users <[hidden email]>
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 [hidden email].
To view this discussion on the web visit https://groups.google.com/d/msgid/jenkinsci-users/df291aff-7fc6-483e-8158-481168b12a35n%40googlegroups.com.

--
You received this message because you are subscribed to a topic in the Google Groups "Jenkins Users" group.
To unsubscribe from this topic, visit https://groups.google.com/d/topic/jenkinsci-users/E6AF3SnV9A0/unsubscribe.
To unsubscribe from this group and all its topics, send an email to [hidden email].
To view this discussion on the web visit https://groups.google.com/d/msgid/jenkinsci-users/eb5ff368-84f8-4045-8336-765944c956dcn%40googlegroups.com.

--
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 [hidden email].

--
You received this message because you are subscribed to a topic in the Google Groups "Jenkins Users" group.
To unsubscribe from this topic, visit https://groups.google.com/d/topic/jenkinsci-users/E6AF3SnV9A0/unsubscribe.
To unsubscribe from this group and all its topics, send an email to [hidden email].
To view this discussion on the web visit https://groups.google.com/d/msgid/jenkinsci-users/fbaf237e-9073-4150-91ec-38221bce85e8n%40googlegroups.com.

--
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 [hidden email].
To view this discussion on the web visit https://groups.google.com/d/msgid/jenkinsci-users/MN2PR18MB27681A396E4BB041A987EDEF888D9%40MN2PR18MB2768.namprd18.prod.outlook.com.

--
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 [hidden email].
To view this discussion on the web visit https://groups.google.com/d/msgid/jenkinsci-users/CAO49JtEqmmB7kxed6fk34%2BoLRqiBGa_ARmJbF5XFV3YfQFWuUA%40mail.gmail.com.