[FIXED JENKINS-12789] Clarification and updating of help

jenkinsci · Feb 15, 2012 · d03fd07 · d03fd07
1 parent 8035bc5
commit d03fd07
Show file tree

Hide file tree

Showing 16 changed files with 34 additions and 38 deletions.
diff --git a/src/main/resources/hudson/plugins/ec2/AmazonEC2Cloud/config-entries.jelly b/src/main/resources/hudson/plugins/ec2/AmazonEC2Cloud/config-entries.jelly
@@ -8,7 +8,7 @@
   <f:entry title="${%Secret Access Key}" field="secretKey">
     <f:password />
   </f:entry>
-  <f:entry title="${%EC2 RSA Private Key}" field="privateKey">
+  <f:entry title="${%EC2 Key Pair's Private Key}" field="privateKey">
     <f:textarea />
   </f:entry>
   <f:advanced>

diff --git a/src/main/resources/hudson/plugins/ec2/AmazonEC2Cloud/help-region.html b/src/main/resources/hudson/plugins/ec2/AmazonEC2Cloud/help-region.html
@@ -1,6 +1,6 @@
 <div>
     Specifies the geographic region in which your slaves will run. Pick the region closest to you. 
     Regions can be thought of as
-    independent instances of EC2/S3. See <a href="http://support.rightscale.com/index.php?title=2._References/02-Cloud_Infrastructures/01-Amazon_Web_Services_(AWS)/02-Amazon_EC2/EC2_Regions:__EC2-US_%26_EC2-EU">online resources</a>
+    independent instances of EC2/S3. See <a href="http://docs.amazonwebservices.com/general/latest/gr/rande.html">AWS documentation</a>
     for more about what regions are.
 </div>
diff --git a/src/main/resources/hudson/plugins/ec2/EC2Cloud/help-accessId.html b/src/main/resources/hudson/plugins/ec2/EC2Cloud/help-accessId.html
@@ -1,5 +1,5 @@
 <div>
-    Hudson uses this access key ID and secret access key to interface with Amazon EC2.
+    Jenkins uses this access key ID and secret access key to interface with Amazon EC2.
     If you have already signed up on EC2, you can obtain this from
     <a href="http://aws-portal.amazon.com/gp/aws/developer/account/index.html?action=access-key">here</a>.
     Otherwise, you need to sign up to Amazon Web Services to get one.

diff --git a/src/main/resources/hudson/plugins/ec2/EC2Cloud/help-instanceCapStr.html b/src/main/resources/hudson/plugins/ec2/EC2Cloud/help-instanceCapStr.html
@@ -1,12 +1,12 @@
 <div>
-    You can place the upward limit to the number of EC2 instances that Hudson may launch.
+    You can place the upward limit to the number of EC2 instances that Jenkins may launch.
     This is useful for avoiding surprises in the billing statement.
 
     <P>
-    For example, if this field is 3, Hudson will only launch a new instance
+    For example, if this field is 3, Jenkins will only launch a new instance
     as long as total number of instances you run on EC2 (regardless of whether that is
-    for Hudson or for other purposes) doesn't exceed this number. In this way,
-    even in the worst case of Hudson starting instances and forgetting about them,
+    for Jenkins or for other purposes) doesn't exceed this number. In this way,
+    even in the worst case of Jenkins starting instances and forgetting about them,
     you have an upper bound in the number of instances that are concurrently executed.
 
     <p>

diff --git a/src/main/resources/hudson/plugins/ec2/EC2Cloud/help-privateKey.html b/src/main/resources/hudson/plugins/ec2/EC2Cloud/help-privateKey.html
@@ -1,12 +1,12 @@
 <div>
     Paste the RSA private key of the EC2 key pair. If you are new to EC2
     and have no idea what this is, you can just generate one (if you do so,
-    you should save the key into a text file, as you'll need it if you
+    you should save the key into a text file, as you will need it if you
     want to login to the EC2 instances via ssh.)
 
     <p>
     An RSA private key for EC2 is a text
     that starts with "-----BEGIN RSA PRIVATE KEY-----". You normally
-    generate it via the "ec2-add-keypair" tool or the equivalent functionality
-    in GUI tools like ElastiFox.
+    generate it via using either the AWS Management Console, the "ec2-add-keypair" tool or a GUI tool
+    like ElastiFox.
 </div>
diff --git a/src/main/resources/hudson/plugins/ec2/EC2Cloud/help-remoteAdmin.html b/src/main/resources/hudson/plugins/ec2/EC2Cloud/help-remoteAdmin.html
@@ -1,8 +1,7 @@
 <div>
-    This field is optional. It controls what usercode to ssh into instances
-    to perform administration. Many EC2 AMI's ship with root as the administrative
-    user, but official Ubuntu images ship with root disabled and the user
-    'ubuntu' available instead. If the user does not have direct administrative
-    access you may also want to set the root command prefix. Hudson will use these
-    two fields to make the root user usable again.
+    This field is optional. Specify the user name used to access the instance using
+    ssh. For many Amazon AMI's this is 'ec2-user'; Ubuntu images use 'ubuntu'. If you
+    don't specify this, 'root' is assumed.
+    If the user does not have direct administrative
+    access, i.e. is not 'root', you should also set the root command prefix, i.e. to 'sudo'. 
 </div>
diff --git a/src/main/resources/hudson/plugins/ec2/EC2Cloud/help-rootCommandPrefix.html b/src/main/resources/hudson/plugins/ec2/EC2Cloud/help-rootCommandPrefix.html
@@ -1,6 +1,5 @@
 <div>
     This field is optional. It supplies a command prefix to use when running an
-    administrative command. E.g. 'sudo'. This is needed for Ubuntu EC2 and UEC
-    machine images where the root user is disabled by default, but the ubuntu
-    user can perform sudo.
+    administrative command, e.g. 'sudo'. This is needed when not using 'root'
+    as a user (which is the typical case).
 </div>
diff --git a/src/main/resources/hudson/plugins/ec2/EC2Slave/help-initScript.html b/src/main/resources/hudson/plugins/ec2/EC2Slave/help-initScript.html
@@ -1,4 +1,4 @@
 <div>
-    This shell script gets executed right after Hudson connects to a new EC2 instance.
+    This shell script gets executed right after Jenkins connects to a new EC2 instance.
     This is a good place to execute a system set up, such as installing some packages.
 </div>
diff --git a/src/main/resources/hudson/plugins/ec2/EC2Slave/help-remoteAdmin.html b/src/main/resources/hudson/plugins/ec2/EC2Slave/help-remoteAdmin.html
@@ -1,8 +1,7 @@
 <div>
-    This field is optional. It controls what usercode to ssh into instances
-    to perform administration. Many EC2 AMI's ship with root as the administrative
-    user, but official Ubuntu images ship with root disabled and the user
-    'ubuntu' available instead. If the user does not have direct administrative
-    access you may also want to set the root command prefix. Hudson will use these
-    two fields to make the root user usable again.
+    This field is optional. Specify the user name used to access the instance using
+    ssh. For many Amazon AMI's this is 'ec2-user'; Ubuntu images use 'ubuntu'. If you
+    don't specify this, 'root' is assumed.
+    If the user does not have direct administrative
+    access, i.e. is not 'root', you should also set the root command prefix, i.e. to 'sudo'. 
 </div>
diff --git a/src/main/resources/hudson/plugins/ec2/EC2Slave/help-rootCommandPrefix.html b/src/main/resources/hudson/plugins/ec2/EC2Slave/help-rootCommandPrefix.html
@@ -1,6 +1,5 @@
 <div>
     This field is optional. It supplies a command prefix to use when running an
-    administrative command. E.g. 'sudo'. This is needed for Ubuntu EC2 and UEC
-    machine images where the root user is disabled by default, but the ubuntu
-    user can perform sudo.
+    administrative command, e.g. 'sudo'. This is needed when not using 'root'
+    as a user (which is the typical case).
 </div>
diff --git a/src/main/resources/hudson/plugins/ec2/EC2Slave/help-type.html b/src/main/resources/hudson/plugins/ec2/EC2Slave/help-type.html
@@ -1,3 +1,3 @@
 <div>
-    Choose the instance type you'd want to launch.
+    Choose the instance type to launch.
 </div>
diff --git a/src/main/resources/hudson/plugins/ec2/Eucalyptus/config-entries.jelly b/src/main/resources/hudson/plugins/ec2/Eucalyptus/config-entries.jelly
@@ -8,7 +8,7 @@
   <f:entry title="${%Secret Key}" field="secretKey">
     <f:password />
   </f:entry>
-  <f:entry title="${%EC2 RSA Private Key}" field="privateKey">
+  <f:entry title="${%EC2 Key Pair's Private Key}" field="privateKey">
     <f:textarea />
   </f:entry>
   <f:advanced>

diff --git a/src/main/resources/hudson/plugins/ec2/SlaveTemplate/config.jelly b/src/main/resources/hudson/plugins/ec2/SlaveTemplate/config.jelly
@@ -38,6 +38,9 @@ THE SOFTWARE.
   <f:entry title="${%Remote user}" field="remoteAdmin">
     <f:textbox />
   </f:entry>
+  <f:entry title="${%Root command prefix}" field="rootCommandPrefix">
+    <f:textbox/>
+  </f:entry>
   <f:entry title="${%Labels}" field="labelString">
     <f:textbox />
   </f:entry>
@@ -51,9 +54,6 @@ THE SOFTWARE.
     <f:entry title="${%Number of Executors}" field="numExecutors">
       <f:textbox />
     </f:entry>
-    <f:entry title="${%Root command prefix}" field="rootCommandPrefix">
-      <f:textbox/>
-    </f:entry>
     <f:entry title="${%JVM Options}" field="jvmopts">
       <f:textbox/>
     </f:entry>

diff --git a/src/main/resources/hudson/plugins/ec2/ebs/ZPoolExpandNotice/index.jelly b/src/main/resources/hudson/plugins/ec2/ebs/ZPoolExpandNotice/index.jelly
@@ -29,8 +29,8 @@ THE SOFTWARE.
 
       <p>
         Your <tt>JENKINS_HOME</tt> (${app.rootDir}) is almost full.
-        When this directory completely fills up, it'll wrec havoc
-        because Hudson can't store any more data.
+        When this directory completely fills up, it will cause problems
+        because Jenkins can't store any more data.
       </p><p>
 
       </p>

diff --git a/src/main/resources/hudson/plugins/ec2/ebs/ZPoolExpandNotice/message.jelly b/src/main/resources/hudson/plugins/ec2/ebs/ZPoolExpandNotice/message.jelly
@@ -25,7 +25,7 @@ THE SOFTWARE.
 <j:jelly xmlns:j="jelly:core" xmlns:st="jelly:stapler" xmlns:d="jelly:define" xmlns:l="/lib/layout" xmlns:t="/lib/hudson" xmlns:f="/lib/form">
   <div class="warning">
     <form method="post" action="${rootURL}/administrativeMonitor/zpool.ebs/">
-      Your data directory in Hudson (${app.rootDir} - AKA <tt>HUDSON_HOME</tt>) is getting close to full.
+      Your data directory in Jenkins (${app.rootDir} - AKA <tt>HUDSON_HOME</tt>) is getting close to full.
       You should act on it before it's completely full.
       <f:submit value="${%Tell me more}"/>
     </form>

diff --git a/src/main/resources/index.jelly b/src/main/resources/index.jelly
@@ -1,5 +1,5 @@
 <div>
-  This plugin integrates Hudson with 
+  This plugin integrates Jenkins with 
   <a href="http://aws.amazon.com/ec2/">Amazon EC2</a> or anything implementing
   the EC2 API's such as an Ubuntu.
 </div>