-
Notifications
You must be signed in to change notification settings - Fork 257
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add online help for addEmbeddableBadgeConfig Pipeline step (#279)
Online help text is copied from the help page of the plugin. There is much to be improved in the help page of the plugin and in the Pipeline help. The Pipeline help would benefit from a better example with multiple configurations that each shows its own status.
- Loading branch information
1 parent
a362ab4
commit 4a95479
Showing
7 changed files
with
29 additions
and
0 deletions.
There are no files selected for viewing
7 changes: 7 additions & 0 deletions
7
...g/jenkinsci/plugins/badge/dsl/AddEmbeddableBadgeConfigStep/help-animatedOverlayColor.html
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
You can override the color using the following valid color values: | ||
|
||
<ul> | ||
<li>one of the values: red, brightgreen, green, yellowgreen, yellow, orange, lightgrey, blue</li> | ||
<li>a valid hexadecimal HTML RGB color without the hashtag (e.g. FFAABB).</li> | ||
<li>any valid <a href="https://www.december.com/html/spec/colorsvg.html">SVG color name</a></li> | ||
</ul> |
7 changes: 7 additions & 0 deletions
7
...in/resources/org/jenkinsci/plugins/badge/dsl/AddEmbeddableBadgeConfigStep/help-color.html
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
You can override the color using the following valid color values: | ||
|
||
<ul> | ||
<li>one of the values: red, brightgreen, green, yellowgreen, yellow, orange, lightgrey, blue</li> | ||
<li>a valid hexadecimal HTML RGB color without the hashtag (e.g. FFAABB).</li> | ||
<li>any valid <a href="https://www.december.com/html/spec/colorsvg.html">SVG color name</a></li> | ||
</ul> |
3 changes: 3 additions & 0 deletions
3
src/main/resources/org/jenkinsci/plugins/badge/dsl/AddEmbeddableBadgeConfigStep/help-id.html
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
The identifier that will be assigned to this embeddable build status configuration. | ||
The identifier is passed as the value of <code>config</code> in the embeddable build status URL parameter. | ||
For example, if the identifier value was <code>win32build</code> then the URL parameter would be <code>config=win32build</code>. |
1 change: 1 addition & 0 deletions
1
...ain/resources/org/jenkinsci/plugins/badge/dsl/AddEmbeddableBadgeConfigStep/help-link.html
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
The link that will be opened when the embeddable build status badge is clicked. |
1 change: 1 addition & 0 deletions
1
...n/resources/org/jenkinsci/plugins/badge/dsl/AddEmbeddableBadgeConfigStep/help-status.html
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
Text that describes the build status, usually the result of the build. |
2 changes: 2 additions & 0 deletions
2
.../resources/org/jenkinsci/plugins/badge/dsl/AddEmbeddableBadgeConfigStep/help-subject.html
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
The text placed on the left side of the embeddable build status. | ||
The subject is "build" by default. |
8 changes: 8 additions & 0 deletions
8
src/main/resources/org/jenkinsci/plugins/badge/dsl/AddEmbeddableBadgeConfigStep/help.html
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
<p> | ||
Additional embeddable build status configurations can be created for a Jenkins Pipeline. | ||
Those embeddable build status configurations can be displayed in the same locations as the default embeddable build status configuration. | ||
For example, if a Pipeline defined a build status configuration named <code>win32build</code>, that configuration can be accessed by appending <code>config=win32build</code> as one of the embeddable build status URL parameters. | ||
</p> | ||
<p> | ||
Refer to the <a href="https://plugins.jenkins.io/embeddable-build-status/#plugin-content-pipeline-dsl">Embeddable build status</a> documentation for more details. | ||
</p> |