Add in-context Jenkinsfile help #947
Conversation
|
These are awesome. What about the case where the jenkins file isn't in the template? |
I added a link to open the same help dialog when using a Jenkinsfile path instead of an embedded Jenkinsfile.
|
Give a brief description of what a Jenkinsfile is with some examples in the build config editor and pipeline pages.
spadgett
force-pushed
the
jenkinsfile-examples
branch
from
eda9c3e to
0a57f73
Compare
|
changes LGTM, will give the others time for feedback |
|
lgtm |
|
[merge] |
|
Evaluated for origin web console merge up to 0a57f73 |
|
Origin Web Console Merge Results: SUCCESS (https://ci.openshift.redhat.com/jenkins/job/test_pull_requests_origin_web_console/772/) (Base Commit: b94910f) |
|
Very helpful, help icon not enough to launch this? |
We could do that, although we've only used the help icon for tooltips elsewhere. @jwforres @ajacobs21e opinion? |
|
yeah we usually use ? for tooltips, in this particular case i think its
nice to see the "What's a Jenkinsfile?"
i'm not against using the ? though, @ajacobs21e ?
…On Wed, Nov 30, 2016 at 8:36 AM, Sam Padgett ***@***.***> wrote:
help icon not enough to launch this
We could do that, although we've only used the help icon for tooltips
elsewhere.
@jwforres <https://github.com/jwforres> @ajacobs21e
<https://github.com/ajacobs21e> opinion?
—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
<#947 (comment)>,
or mute the thread
<https://github.com/notifications/unsubscribe-auth/ABZk7TNTB2iaTI1AyX-OQrLWdYGie6Oeks5rDXv7gaJpZM4K_Ho3>
.
|
|
(?) should be for popovers only. There isn't anything in PatternFly now about what to call these types of links. UX is kind of split on whether or not we should use questions in a UI - I personally would prefer to not use a question for a link. Other options are "Learn More" or "Learn more about Jenkinsfiles". However since this hasn't been decided in PF yet and there's no consistency across products either option is fine for now. |
|
@spadgett @jwforres After talking with UX and thinking some more, learn more isn't quite right either. "Show examples" is clear what you're going to see after clicking the link. We could use "Show jenkinsfile examples" but that is getting kind of long and is probably redundant if it's with the jenkinsfile section. |
Show information about the Jenkinsfile in a modal for pipeline build configs and builds. We give a help link builds that use Jenkinsfile path as well.
https://trello.com/c/nEjWsvyL
Show the examples below the editor when editing a pipeline so that you can copy and paste.
@jwforres @bparees @gabemontero @danmcp @sspeiche