Merge pull request #163 from OpenVoxProject/follow-style-guide

Follow the style-guide

Author: tuxmea

docs/_openvox_8x/cheatsheet_core_types.md

@@ -151,7 +151,7 @@ If a service has a bad init script, you can work around it and manage almost any
 Logs an arbitrary message, at the `notice` log level. This appears in the POSIX syslog or Windows Event Log on the Puppet agent node and is also logged in reports.
 
 ``` puppet
-notify { "This message is getting logged on the agent node.": }
+notify { 'This message is getting logged on the agent node.': }
 ```
 
 {:.section}
@@ -194,8 +194,8 @@ Executes an arbitrary command on the agent node. When using execs, you must eith
 Manages cron jobs. Largely self-explanatory. On Windows, you should use [`scheduled_task`](./type.html#scheduledtask) instead.
 
     cron { 'logrotate':
-      command => "/usr/sbin/logrotate",
-      user    => "root",
+      command => '/usr/sbin/logrotate',
+      user    => 'root',
       hour    => 2,
       minute  => 0,
     }
@@ -219,7 +219,7 @@ Manages cron jobs. Largely self-explanatory. On Windows, you should use [`schedu
 
 Manages user accounts; mostly used for system users.
 
-    user { "jane":
+    user { 'jane':
         ensure     => present,
         uid        => '507',
         gid        => 'admin',

docs/_openvox_8x/cheatsheet_module.md

@@ -40,21 +40,22 @@ This directory holds the module's Puppet code.
 
 **apache/manifests/init.pp**
 
-```
+``` puppet
 class apache {
-...
+  ...
 }
 ```
 
 `init.pp` is special; it should contain a class (or defined type) with the same name as the module.
 
 **apache/manifests/vhost.pp**
 
-```
-define apache::vhost 
-($port, $docroot) 
-{
-...
+``` puppet
+define apache::vhost(
+  $port,
+  $docroot,
+) {
+  ...
 }
 ```
 
@@ -64,9 +65,9 @@ Other classes (and defined types) should be named
 
 **apache/manifests/config/ssl.pp**
 
-```
+``` puppet
 class apache::config::ssl {
-...
+  ...
 }
 ```
 
@@ -87,8 +88,8 @@ filename`.
 
 To fetch this file:
 
-```
-file {'/etc/apache2/httpd.conf':
+``` puppet
+file { '/etc/apache2/httpd.conf':
   ensure => file,
   source => 'puppet:///modules/apache/httpd.conf',
 }
@@ -98,8 +99,8 @@ file {'/etc/apache2/httpd.conf':
 
 Puppet's file server can navigate any subdirectories:
 
-```
-file {'/etc/apache2/httpd-ssl.conf':
+``` puppet
+file { '/etc/apache2/httpd-ssl.conf':
   ensure => file,
   source => 'puppet:///modules/apache/extra/ssl',
 }
@@ -132,7 +133,7 @@ This directory holds ERB templates.
 
 To use this template:
 
-```
+``` puppet
 file     {'/etc/apache2/sites-enabled/wordpress.conf':
   ensure => file,
   content => template('apache/vhost.erb'),

docs/_openvox_8x/custom_types.markdown

@@ -90,19 +90,19 @@ You can and should write a string describing the resource type and assign it to
 The string should be in [Markdown][] format (avoiding dialect-specific features that aren't universally supported). When the Puppet tools extract the string, they will strip the greatest common amount of leading whitespace from the front of each line, excluding the first line. For example:
 
 ``` ruby
-    Puppet::Type.newtype(:database) do
-      @doc = %q{Creates a new database. Depending
-        on the provider, this might create relational
-        databases or NoSQL document stores.
-
-        Example:
-
-            database {'mydatabase':
-              ensure => present,
-              owner  => root,
-            }
-      }
-    end
+Puppet::Type.newtype(:database) do
+  @doc = %q{Creates a new database. Depending
+    on the provider, this might create relational
+    databases or NoSQL document stores.
+
+    Example:
+
+        database { 'mydatabase':
+          ensure => present,
+          owner  => root,
+        }
+  }
+end
 ```
 
 In this example, any whitespace would be trimmed from the first line (in this case, it's zero spaces), then the greatest common amount would be trimmed from remaining lines. Three lines have four leading spaces, two lines have six, and two lines have eight, so four leading spaces would be trimmed from each line. This leaves the example code block indented by four spaces, and thus doesn't break the Markdown formatting.

docs/_openvox_8x/designing_advanced_profiles.md

@@ -585,7 +585,7 @@ class profile::jenkins::master (
   # ...
   if $jenkins_logs_to_syslog {
     jenkins::sysconfig { 'JENKINS_LOG':
-      value => "$jenkins_logs_to_syslog",
+      value => $jenkins_logs_to_syslog,
     }
   }
   # ...
@@ -634,7 +634,7 @@ class profile::jenkins::master (
 +  # separate log file eg. daemon.info
 +  if $jenkins_logs_to_syslog {
 +    jenkins::sysconfig { 'JENKINS_LOG':
-+      value => "$jenkins_logs_to_syslog",
++      value => $jenkins_logs_to_syslog,
 +    }
 +  }
 +
@@ -974,7 +974,7 @@ class profile::jenkins::master (
   # separate log file eg. daemon.info
   if $jenkins_logs_to_syslog {
     jenkins::sysconfig { 'JENKINS_LOG':
-      value => "$jenkins_logs_to_syslog",
+      value => $jenkins_logs_to_syslog,
     }
   }
 

docs/_openvox_8x/lang_classes.markdown

@@ -69,16 +69,16 @@ class base::linux {
 ``` puppet
 # A class with parameters
 class apache (String $version = 'latest') {
-  package {'httpd':
+  package { 'httpd':
     ensure => $version, # Using the class parameter from above
     before => File['/etc/httpd.conf'],
   }
-  file {'/etc/httpd.conf':
+  file { '/etc/httpd.conf':
     ensure  => file,
     owner   => 'httpd',
     content => template('apache/httpd.conf.erb'), # Template from a module
   }
-  service {'httpd':
+  service { 'httpd':
     ensure    => running,
     enable    => true,
     subscribe => File['/etc/httpd.conf'],
@@ -209,7 +209,7 @@ Some resource attributes, such as the [relationship metaparameters][relationship
 
 ``` puppet
 class apache {
-  service {'apache':
+  service { 'apache':
     require => Package['httpd'],
   }
 }
@@ -371,11 +371,11 @@ Resource-like declarations look like [normal resource declarations][resource_dec
 
 ``` puppet
 # Specifying the "version" parameter:
-class {'apache':
+class { 'apache':
   version => '2.2.21',
 }
 # Declaring a class with no parameters:
-class {'base::linux':}
+class { 'base::linux': }
 ```
 
 Resource-like declarations use [resource-like behavior][resource-like]. (Multiple declarations prohibited; parameters can be overridden at compile-time.) You can provide a value for any class parameter by specifying it as resource attribute; any parameters not specified will follow the normal external/default/fail lookup path.
@@ -384,7 +384,7 @@ In addition to class-specific parameters, you can also specify a value for any [
 
 ``` puppet
 # Cause the entire class to be noop:
-class {'apache':
+class { 'apache':
   noop => true,
 }
 ```

docs/_openvox_8x/lang_comments.markdown

@@ -12,7 +12,7 @@ Shell-style comments (also known as Ruby-style comments) begin with a hash symbo
 
 ``` puppet
 # This is a comment
-file {'/etc/ntp.conf': # This is another comment
+file { '/etc/ntp.conf': # This is another comment
   ensure => file,
   owner  => root,
 }

docs/_openvox_8x/lang_containment.markdown

@@ -32,7 +32,7 @@ class ntp {
 }
 
 include ntp
-exec {'/usr/local/bin/update_custom_timestamps.sh':
+exec { '/usr/local/bin/update_custom_timestamps.sh':
   require => Class['ntp'],
 }
 ```

docs/_openvox_8x/lang_data_resource_reference.md

@@ -64,16 +64,16 @@ They can be used wherever an array of references might be used. They can also go
 You can use a resource reference to access the values of a [resource][]'s attributes. To access a value, use square brackets and the name of an attribute (as a [string][]). This works much like [accessing hash values.][hash access]
 
 ``` puppet
-file { "/etc/first.conf":
+file { '/etc/first.conf':
   ensure => file,
-  mode   => "0644",
-  owner  => "root",
+  mode   => '0644',
+  owner  => 'root',
 }
 
-file { "/etc/second.conf":
+file { '/etc/second.conf':
   ensure => file,
-  mode   => File["/etc/first.conf"]["mode"],
-  owner  => File["/etc/first.conf"]["owner"],
+  mode   => File['/etc/first.conf']['mode'],
+  owner  => File['/etc/first.conf']['owner'],
 }
 ```
 
@@ -115,7 +115,7 @@ To allow a resource reference of a _specific_ resource type --- in this example,
 
 ``` puppet
 Type[File]              # Capitalized resource type name
-Type[Resource["file"]]  # `Resource` data type, with type name in parameter as a string
+Type[Resource['file']]  # `Resource` data type, with type name in parameter as a string
 Type[Resource[File]]    # `Resource` data type, with capitalized resource type name
 ```
 

docs/_openvox_8x/lang_data_resource_type.md

@@ -40,24 +40,24 @@ For example:
 
 ``` puppet
 # A resource declaration using a resource data type:
-File { "/etc/ntp.conf":
-  mode  => "0644",
-  owner => "root",
-  group => "root",
+File { '/etc/ntp.conf':
+  mode  => '0644',
+  owner => 'root',
+  group => 'root',
 }
 
 # Equivalent to the above:
-Resource["file"] { "/etc/ntp.conf":
-  mode  => "0644",
-  owner => "root",
-  group => "root",
+Resource['file'] { '/etc/ntp.conf':
+  mode  => '0644',
+  owner => 'root',
+  group => 'root',
 }
 
 # A resource default:
 File {
-  mode  => "0644",
-  owner => "root",
-  group => "root",
+  mode  => '0644',
+  owner => 'root',
+  group => 'root',
 }
 ```
 
@@ -119,21 +119,21 @@ All of these parameters are optional. They must be listed in order; if you need
 
 Position | Parameter        | Data Type | Default Value | Description
 ---------| -----------------|-----------|---------------|------------
-1 | Resource type | `String` or `Resource` | nothing | A resource type, either as a string or a `Resource` data type value. If provided, this will turn this data type into a resource-specific data type. `Resource[Mytype]` and `Resource["mytype"]` are both 100% identical to the data type `Mytype`.
-2–∞ | Resource title | `String` | nothing | The title of some specific resource of this type. If provided, this will turn this data type into a usable [resource reference][] or array of resource references. `Resource[Mytype, "mytitle"]` and `Resource["mytype", "mytitle"]` are both 100% identical to the data type `Mytype["mytitle"]`.
+1 | Resource type | `String` or `Resource` | nothing | A resource type, either as a string or a `Resource` data type value. If provided, this will turn this data type into a resource-specific data type. `Resource[Mytype]` and `Resource['mytype']` are both 100% identical to the data type `Mytype`.
+2–∞ | Resource title | `String` | nothing | The title of some specific resource of this type. If provided, this will turn this data type into a usable [resource reference][] or array of resource references. `Resource[Mytype, 'mytitle']` and `Resource['mytype', 'mytitle']` are both 100% identical to the data type `Mytype['mytitle']`.
 
 
 ### Examples
 
 * `Resource[File]` --- the data type corresponding to the `file` resource type.
 * `Resource[File, '/tmp/foo']` --- a resource reference to the `file` resource whose title is `/tmp/foo`.
-* `Resource["file", '/tmp/foo']` --- a resource reference to the `file` resource whose title is `/tmp/foo`.
+* `Resource['file', '/tmp/foo']` --- a resource reference to the `file` resource whose title is `/tmp/foo`.
 * `Resource[File, '/tmp/foo', '/tmp/bar']` --- equivalent to `[ File['/tmp/foo'], File['/tmp/bar'] ]`.
 
 Also:
 
 * `Type[Resource[File]]` --- a synonym for the data type that _matches_ any [resource references][resource reference] to `file` resources. This is useful for, e.g., restricting the values of class or defined type parameters.
-* `Type[Resource["file"]]` --- another synonym for the data type that _matches_ any [resource references][resource reference] to `file` resources. This is useful for, e.g., restricting the values of class or defined type parameters.
+* `Type[Resource['file']]` --- another synonym for the data type that _matches_ any [resource references][resource reference] to `file` resources. This is useful for, e.g., restricting the values of class or defined type parameters.
 
 
 ## The `Class` data type
@@ -159,7 +159,7 @@ Position | Parameter        | Data Type | Default Value | Description
 
 ### Examples
 
-* `Class["apache"]` --- a [class reference][] to class `apache`.
+* `Class['apache']` --- a [class reference][] to class `apache`.
 
 Also:
 

docs/_openvox_8x/lang_data_string.md

@@ -38,7 +38,7 @@ Each of these have slightly different behavior around syntax, interpolation feat
 ## Bare words
 
 ``` puppet
-service { "ntp":
+service { 'ntp':
   ensure => running, # bare word string
 }
 ```