[JENKINS-30086] Steps help and decription clean up

Originally-Committed-As: 0b1c5dcd53f0a456ef243a360ad36f6f23cc8bbe
jenkinsci · Sep 25, 2015 · a164652 · a164652
1 parent 42a7e21
commit a164652
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 1 deletion.
diff --git a/support/src/main/java/org/jenkinsci/plugins/workflow/support/steps/input/InputStep.java b/support/src/main/java/org/jenkinsci/plugins/workflow/support/steps/input/InputStep.java
@@ -145,7 +145,7 @@ public String getFunctionName() {
 
         @Override
         public String getDisplayName() {
-            return "Input";
+            return "Wait for interactive input";
         }
     }
 }
diff --git a/.../main/resources/org/jenkinsci/plugins/workflow/support/steps/input/InputStep/help-id.html b/.../main/resources/org/jenkinsci/plugins/workflow/support/steps/input/InputStep/help-id.html
@@ -0,0 +1,6 @@
+<p>
+    Every <code>input</code> step has an unique ID. It is used in the generated URL to proceed or abort.
+</p>
+<p>
+    A specific ID could be used, for example, to mechanically respond to the input from some external process/tool.
+</p>
diff --git a/...src/main/resources/org/jenkinsci/plugins/workflow/support/steps/input/InputStep/help.html b/...src/main/resources/org/jenkinsci/plugins/workflow/support/steps/input/InputStep/help.html
@@ -0,0 +1,11 @@
+<div>
+    <p>
+    This step pauses flow execution and allows the user to interact and control the flow of the build.
+    Only a basic "process" or "abort" option is provided in the stage view.
+    </p>
+    <p>
+    You can optionally request information back, hence the name of the step. 
+    The parameter entry screen can be accessed via a link at the bottom of the build console log or
+    via link in the sidebar for a build.
+    </p>
+</div>