(SIMP-103) Make first set of corrections on docs

Fixed some typos on original documentation -- not complete Updated spaces and also conditional (which defaults to no tags but can be fixed) SIMP-103 #close Fixed some of the typoes Change-Id: I29449091d3fdf961bea3ba7ac353c6ddf35e5dac
simp · Jul 2, 2015 · 05ae655 · 05ae655
1 parent 6de090c
commit 05ae655
Show file tree

Hide file tree

Showing 22 changed files with 113 additions and 111 deletions.
diff --git a/.travis.yml b/.travis.yml
@@ -4,4 +4,4 @@ language: python
 python:
   - "2.7"
 install: "pip install -q -r requirements.txt --use-mirrors"
-script: sphinx-build -n -b html -d _build/sphinx_cache docs/ _build/html
+script: sphinx-build -n -t simp_5_1_0 -b html -d _build/sphinx_cache docs/ _build/html
diff --git a/docs/index.rst b/docs/index.rst
@@ -2,20 +2,30 @@
 
 Welcome to SIMP's documentation!
 ================================
+.. only:: not simp_4_2_0
 
-    This is the &SIMP_VERSION;-&SIMP_RELEASE; release of the SIMP
-    product based on the &RHEL_VERSION; release of CentOS and Red Hat
-    Enterprise Linux (RHEL).
-
-    SIMP is a minimized, security-focused, continually managed
-    operating system overlay compatible with RHEL and CentOS. Each
-    system is tailored to the hosted project's needs using Puppet.
-
-    Fundamentally, SIMP is a framework that is designed to be secure
-    from a practical point of view out of the box. As a framework,
-    SIMP is designed to be flexed to meet the needs of the end user.
-    If, for some reason, this is not possible, then this should be
-    reported to the developers as a bug.
+  This is the 5.1.0  release of the SIMP
+  product based on the 7.1 release of CentOS and Red Hat
+  Enterprise Linux (RHEL).
+
+
+.. only:: simp_4_2_0
+
+  This is the 4.2.0 release of the SIMP
+  product based on the 6.6 release of CentOS and Red Hat
+  Enterprise Linux (RHEL).
+
+..
+
+SIMP is a minimized, security-focused, continually managed
+operating system overlay compatible with RHEL and CentOS. Each
+system is tailored to the hosted project's needs using Puppet.
+
+Fundamentally, SIMP is a framework that is designed to be secure
+from a practical point of view out of the box. As a framework,
+SIMP is designed to be flexed to meet the needs of the end user.
+If, for some reason, this is not possible, then this should be
+reported to the developers as a bug.
 
 
 Contents:

diff --git a/docs/installation_guide/Hiera_Overview.rst b/docs/installation_guide/Hiera_Overview.rst
@@ -26,7 +26,7 @@ Adding a Key/Value Pair to Hiera Examples
           ---
           classfoo::parameter_bar: "Woo"
           classfoo::parameter_baz: "Hoo"
-          
+
 
 You can then 'include classfoo' on any node, with parameter\_bar and
 parameter\_baz defaulting to Woo and Hoo, respectively.
@@ -89,7 +89,7 @@ Adding a Site Manifest Examples
 
             tftpboot::assign_host { 'default': model => 'CentOS_RHEL_MAJOR_VERSION' }
           }
-          
+
 
 Then, in */etc/puppet/hieradata/hosts/puppet.your.domain.yaml*
 
@@ -100,7 +100,7 @@ Adding TFTP Site to Hirea Examples
           ---
           classes:
             - 'site::tftpboot'
-          
+
 
 SIMP Hiera File Structure
 -------------------------

diff --git a/docs/installation_guide/PXE_Boot.rst b/docs/installation_guide/PXE_Boot.rst
@@ -89,7 +89,7 @@ TFTP Examples
 
               tftpboot::assign_host { 'default': model => 'CentOS_RHEL_MAJOR_VERSION' }
             }
-            
+
 
 Next, add the tftpboot site manifest to your puppet server node via
 Hiera. If it does not already exist, create
@@ -104,7 +104,7 @@ TFTP Examples
             ---
             classes:
               - 'site::tftpboot'
-            
+
 
 After updating the above file, type **puppet agent -t --tags tftpboot**
 on the Puppet server.
diff --git a/docs/installation_guide/SIMP_Server_Installation.rst b/docs/installation_guide/SIMP_Server_Installation.rst
@@ -36,7 +36,7 @@ repeatable.
 
 Using the configuration script, the following items are configured:
 
-**NOTE** this needs updated for the new puppetserver settings 
+**NOTE** this needs updated for the new puppetserver settings
 which includes Puppet Environments
 
 -  Grub password in */boot/grub/grub.conf*
@@ -151,7 +151,7 @@ The following table outlines the steps to install a SIMP server.
 +--------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 | Step   | Process/Action                                                                                                                                                                                                                                              |
 +========+=============================================================================================================================================================================================================================================================+
-| 1.     | Log on as *simp*\ and **su -** to gain root access.                                                                                                                                                                                                         |
+| 1.     | Log on as *simp* and **su -** to gain root access.                                                                                                                                                                                                          |
 +--------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 | 2.     | Type **simp config**                                                                                                                                                                                                                                        |
 |        |                                                                                                                                                                                                                                                             |
@@ -163,7 +163,7 @@ The following table outlines the steps to install a SIMP server.
 +--------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 | 4.     | Type **simp bootstrap**                                                                                                                                                                                                                                     |
 |        |                                                                                                                                                                                                                                                             |
-|        | **NOTE**: If progress bars are of equal length and the bootstrap finishes quickly, a problem has occured. This is most likely due to an error in SIMP configuration. Refer to the previous step and make sure that all configuration options are correct.   |
+|        | **NOTE**: If progress bars are of equal length and the bootstrap finishes quickly, a problem has occurred. This is most likely due to an error in SIMP configuration. Refer to the previous step and make sure that all configuration options are correct.  |
 +--------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 | 5.     | Type **reboot**                                                                                                                                                                                                                                             |
 +--------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

diff --git a/docs/license.rst b/docs/license.rst
@@ -12,14 +12,14 @@ makes no representation about the suitability of the SIMP product for
 any purpose. It is provided "as is" without
 expressed or implied warranty. If SIMP is modified in any way, except
 for designed customization, identify the new copy as a variant of
-SIMP. 
+SIMP.
 
 Additional products are distributed
 as part of the SIMP suite, including but not limited to, Puppet,
 CentOS, and Red Hat Enterprise Linux (RHEL). By using SIMP, the user
 agrees to abide by the licenses for the included products,
 particularly the purchase of RHEL licenses if using the Red Hat
-version of SIMP. 
+version of SIMP.
 
 At this time,
 RHEL is the only product requiring payment for a commercial license in

diff --git a/docs/user_guide/FAQs/Centralized_Logging.rst b/docs/user_guide/FAQs/Centralized_Logging.rst
@@ -19,7 +19,7 @@ Code to Enable the Server Logging Examples
 
           classes :
             - 'simp::rsyslog::stock'
-          
+
 
 Enable the Clients
 ------------------

diff --git a/docs/user_guide/FAQs/Changing_Puppet_Masters.rst b/docs/user_guide/FAQs/Changing_Puppet_Masters.rst
@@ -16,7 +16,7 @@ Code Changes on Client to Switch Puppet Masters
             server = new.puppet.master.fqdn
             ca_server = new.puppet.master.fqdn
             ca_port = 8141
-            
+
 
 To remove all files and sub-directories in the */var/lib/puppet/ssl*
 directory, type **cd /var/lib/puppet/ssl**. Then type **rm -rf ./\***.

diff --git a/docs/user_guide/FAQs/Override_Security_Module.rst b/docs/user_guide/FAQs/Override_Security_Module.rst
@@ -49,7 +49,7 @@ Break Out Security Settings from the Application
 
               include "secure_config"
             }
-            
+
 
 By entering this information, the user can ensure that all nodes that
 are built have the advanced security class applied to them if they are
@@ -113,7 +113,7 @@ Remove Security Module from Site Files
                  }
                }
              }
-            
+
 
 By using the example, the :term:`Network File System (NFS)` service will be enabled if, and only if, the
 *$security\_override\_enable\_nfs* variable is set to the value
@@ -142,7 +142,7 @@ Set All Security Default Site Settings Examples
               $security_override_enable_nfs = "true"
               include "site::security_override"
             }
-            
+
 
 These steps for overriding the security module can be applied as needed
 to any of the base modules.
diff --git a/docs/user_guide/FAQs/Puppet_Server_NAT.rst b/docs/user_guide/FAQs/Puppet_Server_NAT.rst
@@ -17,7 +17,7 @@ Example Sample Entries in vars.pp
 
            $puppet_server_hosts_mod = "puppet.$dns_domain|1.2.3.4 puppet2.$dns_domain|2.3.4.5"
            $puppet_servers = template('site/nat_ip_switch.erb')
-          
+
 
 Create a */etc/puppet/modules/site/templates/nat\_ip\_switch.erb* file
 with the content shown in the next example. Change the appropriate
@@ -62,7 +62,7 @@ Source Create the nat\_ip\_switch.erb
             end
             -%>
             <%= t_pupsrvs -%>
-          
+
 
 Run **puppet agent -t** on the client to receive the appropriately
 mapped NAT address of the Puppet server.

diff --git a/docs/user_guide/FAQs/Redundant_LDAP.rst b/docs/user_guide/FAQs/Redundant_LDAP.rst
@@ -47,7 +47,7 @@ Source Code for Using an OpenLDAP Server openldap
             node ldapmaster {
               include 'ldap_master'
             }
-          
+
 .. _Redundant_LDAP-Replicants:
 
 Set up the Replicated Servers
@@ -85,7 +85,7 @@ Source Code to Configure an LDAP Slave Node replication
             node ldaprepl2 {
               include "ldap_repl"
             }
-          
+
 
 Promote a Slave Node
 --------------------
@@ -111,7 +111,7 @@ Source Promoting a Slave Node LDAP
               # include 'ldap_repl'
               include 'ldap_master'
             }
-          
+
 
 After the next Puppet run on all hosts, *ldaprepl1* will be promoted to
 the master and all slave nodes will point to it.
@@ -139,7 +139,7 @@ Update $ldap\_sync Information in LDAP Examples
             changetype: modify
             replace: userPassword
             userPassword: <Hash from $ldap_sync_hash>
-            
+
 
 Master Node Demotion
 ~~~~~~~~~~~~~~~~~~~~

diff --git a/docs/user_guide/FAQs/SFTP_Restricted_Accounts.rst b/docs/user_guide/FAQs/SFTP_Restricted_Accounts.rst
@@ -21,7 +21,7 @@ Create a User Account Examples
 
             On a SIMP system, shell would be:
             "/usr/libexec/openssh/sftp-server"
-          
+
 
 Modify */etc/shells*
 --------------------

diff --git a/docs/user_guide/Kerberos.rst b/docs/user_guide/Kerberos.rst
@@ -51,7 +51,7 @@ Code for Creating an Admin Principal Kerberos
               principal       => "*/admin@${::domain}",
               operation_mask  => '*'
             }
-            
+
 
 The table below lists the steps to create an admin principal that is
 appropriate for common organizations. These steps should be accomplished

diff --git a/docs/user_guide/Logstash.rst b/docs/user_guide/Logstash.rst
@@ -76,7 +76,7 @@ Logstash, SIMP, and Security
 
 The provided SIMP modules for Logstash, Elasticsearch, and Kibana have
 been built with connection security in mind. Overriding these settings
-could adversely effect the security of the logging infrastructure. The
+could adversely affect the security of the logging infrastructure. The
 following list describes the security features in place with the default
 SIMP module settings:
 
@@ -108,7 +108,7 @@ SIMP module settings:
     The Puppet modules for Logstash, Kibana, and Elasticsearch contain
     dozens of variables that may be manipulated. You should read each
     product's documentation and ensure you understand any setting that
-    is changed from the default SIMP values. Changes can effect both
+    is changed from the default SIMP values. Changes can affect both
     security and functionality of the system.
 
 Logstash Setup
@@ -179,7 +179,7 @@ large /var volume and 4GB of memory.
           classes:
             - 'logstash::simp'
             - 'kibana'
-              
+
 
 In the case of the Elasticsearch node setup below, it may be better to
 use a group match to pull your Hiera settings. To do this, you should
@@ -190,7 +190,7 @@ add the following to a file like /etc/puppet/manifests/nodegroups.pp
           if $trusted['certname'] =~ /es\d+\.your\.domain/ {
             $hostgroup = 'elasticsearch'
           }
-            
+
 
 Then, ensure that a file called 'elasticsearch.yaml' is present in the
 /etc/puppet/hieradata/hostgroups directory and contains the following
@@ -209,7 +209,7 @@ content.
 
           classes:
             - 'elasticsearch::simp'
-              
+
 
 Make sure you point your clients to the Logstash server by setting the
 'log\_server' variable to the fqdn of the Logstash server in hiera. This

diff --git a/docs/user_guide/Managing_Workstation_Infrastructures.rst b/docs/user_guide/Managing_Workstation_Infrastructures.rst
@@ -63,7 +63,7 @@ user workstation.
               ]: ensure => 'latest'
               }
             }
-                
+
 
 Graphical Desktop Setup
 -----------------------
@@ -90,7 +90,7 @@ desktop on a user workstation.
                 ensure => 'latest'
               }
             }
-                
+
 
 Workstation Repositories
 ------------------------
@@ -105,7 +105,7 @@ repositories.
               # Whatever local yumrepo statements you need for installing
               # your packages and keeping your systems up to date
             }
-                
+
 
 Virtualization on User Workstations
 -----------------------------------
@@ -151,7 +151,7 @@ on a user workstation.
 
               package { 'virt-manager': ensure => 'latest' }
             }
-                
+
 
 Network File System
 -------------------
@@ -183,7 +183,7 @@ Below is an example manifest called
             Target     => ‘share’
             }
             }
-                
+
 
 Setting up a Printer Environment
 --------------------------------
@@ -213,7 +213,7 @@ print client.
               package { 'cups-pk-helper': ensure => 'latest' }
               package { 'system-config-printer': ensure => 'present' }
             }
-                
+
 
 Setting up a Print Server
 ~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -238,7 +238,7 @@ print server.
                 require    => Package['cups']
               }
             }
-                
+
 
 VNC
 ===
@@ -327,7 +327,7 @@ VNC Server node
               - 'windowmanager::gnome'
               - 'mozilla::firefox'
               - 'vnc::server'
-                
+
 
 VNC client node
 
@@ -338,7 +338,7 @@ VNC client node
               - 'windowmanager::gnome'
               - 'mozilla::firefox'
               - 'vnc::client'
-                
+
 
 Run the Server
 ~~~~~~~~~~~~~~

diff --git a/docs/user_guide/Maximum_Nodes.rst b/docs/user_guide/Maximum_Nodes.rst
@@ -16,7 +16,7 @@ number of nodes, nodes begin to drop to compile times lower than 30
 seconds. These nodes are not actually completing their Puppet runs. This
 data can be seen in the following graph:
 
-Number of Nodes vs. Compile Time 
+Number of Nodes vs. Compile Time
 --------------------------------
 
 The queue size can be found by looking at the maximum number of clients

diff --git a/docs/user_guide/Openstack_Integration.rst b/docs/user_guide/Openstack_Integration.rst
@@ -9,7 +9,7 @@ OpenStack In SIMP - IceHouse
 
 OpenStack is a collection of IaaS cloud computing services aimed at
 creating a free and open source platform for cloud development and
-deployment. It is designed in a modular fasion, encompassing the
+deployment. It is designed in a modular fashion, encompassing the
 following components:
 
 -  **Cinder**\ Block Storage Service