Merge pull request #2931 from jeff1evesque/feature-2925

#2925: Remove and reduce puppet docstring
jeff1evesque · Mar 6, 2017 · ac1053b · ac1053b
2 parents 47fd5cb + 0c283fb
commit ac1053b
Show file tree

Hide file tree

Showing 90 changed files with 160 additions and 279 deletions.
diff --git a/puppet/environment/docker/manifests/compile_asset.pp b/puppet/environment/docker/manifests/compile_asset.pp
@@ -1,10 +1,7 @@
+###
 ### compile_asset.pp: install, configure, and run initial compile against
 ###                   source files.
 ###
-### Note: the prefix 'package::', corresponds to a puppet convention:
-###
-###       https://github.com/jeff1evesque/machine-learning/issues/2349
-###
 
 ## ensure log directory, package dependencies
 class dependencies {

diff --git a/puppet/environment/docker/manifests/configure_redis.pp b/puppet/environment/docker/manifests/configure_redis.pp
@@ -1,8 +1,5 @@
-### configure_redis.pp: install redis client, and redis server.
-###
-### Note: the prefix 'package::', corresponds to a puppet convention:
 ###
-###       https://github.com/jeff1evesque/machine-learning/issues/2349
+### configure_redis.pp: install redis client, and redis server.
 ###
 
 ## install redis-server

diff --git a/puppet/environment/docker/manifests/configure_system.pp b/puppet/environment/docker/manifests/configure_system.pp
@@ -1,8 +1,5 @@
-### configure_system.pp: configure system with general requirements.
-###
-### Note: the prefix 'package::', corresponds to a puppet convention:
 ###
-###       https://github.com/jeff1evesque/machine-learning/issues/2349
+### configure_system.pp: configure system with general requirements.
 ###
 
 ## ensure log directory

diff --git a/puppet/environment/docker/manifests/install_packages.pp b/puppet/environment/docker/manifests/install_packages.pp
@@ -1,13 +1,10 @@
-### install_packages.pp: install general packages.
-###
-### Note: the prefix 'package::', corresponds to a puppet convention:
 ###
-###       https://github.com/jeff1evesque/machine-learning/issues/2349
+### install_packages.pp: install general packages.
 ###
 
 ## nodejs, with npm: this cannot be wrapped into a module, and included, as
-#      needed. Puppet will only allow one instance of this class, regardless of
-#      of its implementation.
+##     needed. Puppet will only allow one instance of this class, regardless of
+##     of its implementation.
 class install_nodejs {
     ## set dependency
     require apt

diff --git a/puppet/environment/docker/manifests/install_sklearn.pp b/puppet/environment/docker/manifests/install_sklearn.pp
@@ -1,8 +1,5 @@
-### install_sklearn.pp: install sklearn, with all necessary dependencies.
-###
-### Note: the prefix 'package::', corresponds to a puppet convention:
 ###
-###       https://github.com/jeff1evesque/machine-learning/issues/2349
+### install_sklearn.pp: install sklearn, with all necessary dependencies.
 ###
 
 ## create '/vagrant/build/' directory

diff --git a/puppet/environment/docker/manifests/setup_database.pp b/puppet/environment/docker/manifests/setup_database.pp
@@ -1,8 +1,5 @@
-### setup_database.pp: install client, and initialize database tables.
-###
-### Note: the prefix 'package::', corresponds to a puppet convention:
 ###
-###       https://github.com/jeff1evesque/machine-learning/issues/2349
+### setup_database.pp: install client, and initialize database tables.
 ###
 
 ## install sql

diff --git a/puppet/environment/docker/manifests/start_webserver.pp b/puppet/environment/docker/manifests/start_webserver.pp
@@ -1,10 +1,7 @@
+###
 ### start_webserver.pp: start webserver, and ensure all client services exist,
 ###                     and properly configured.
 ###
-### Note: the prefix 'package::', corresponds to a puppet convention:
-###
-###       https://github.com/jeff1evesque/machine-learning/issues/2349
-###
 
 ## install mariadb
 include database::client

diff --git a/puppet/environment/docker/modules/compiler/manifests/initial_compile.pp b/puppet/environment/docker/modules/compiler/manifests/initial_compile.pp
@@ -1,6 +1,5 @@
-### Note: the prefix 'compiler::::', corresponds to a puppet convention:
 ###
-###       https://github.com/jeff1evesque/machine-learning/issues/2349
+### initial_compile.pp, manually compile javascript.
 ###
 class compiler::initial_compile {
     ## local variables
@@ -16,7 +15,7 @@
     ]
 
     ## manually compile jsx asset, since first pass through via
-    # 'start_uglifyjs.pp' does not have adequate scope resolution.
+    ## 'start_uglifyjs.pp' does not have adequate scope resolution.
     exec { 'rerun-uglifyjs':
         command  => "./uglifyjs ${root_dir}",
         cwd      => "${dev_env_path}/modules/compiler/scripts",

diff --git a/puppet/environment/docker/modules/compiler/manifests/start_browserify.pp b/puppet/environment/docker/modules/compiler/manifests/start_browserify.pp
@@ -1,15 +1,14 @@
-### Note: the prefix 'compiler::', corresponds to a puppet convention:
 ###
-###       https://github.com/jeff1evesque/machine-learning/issues/2349
+### start_browserify.pp, compile jsx into javascript.
 ###
 class compiler::start_browserify {
-    # variables
+    ## variables
     $hiera_general   = lookup('general')
     $root_dir        = $hiera_general['root']
     $environment     = $hiera_general['environment']
     $dev_env_path    = "${root_dir}/puppet/environment/${environment}"
 
-    # manually compile
+    ## manually compile
     exec { 'browserify':
         command  => "./browserify ${root_dir}",
         cwd      => "${dev_env_path}/modules/compiler/scripts",

diff --git a/puppet/environment/docker/modules/compiler/manifests/start_imagemin.pp b/puppet/environment/docker/modules/compiler/manifests/start_imagemin.pp
@@ -1,15 +1,14 @@
-### Note: the prefix 'compiler::', corresponds to a puppet convention:
 ###
-###       https://github.com/jeff1evesque/machine-learning/issues/2349
+### start_imagemin.pp, minify images, when possible.
 ###
 class compiler::start_imagemin {
-    # variables
+    ## variables
     $hiera_general   = lookup('general')
     $root_dir        = $hiera_general['root']
     $environment     = $hiera_general['environment']
     $dev_env_path    = "${root_dir}/puppet/environment/${environment}"
 
-    # manually compile
+    ## manually compile
     exec { 'imagemin':
         command  => "./imagemin ${root_dir}",
         cwd      => "${dev_env_path}/modules/compiler/scripts",

diff --git a/puppet/environment/docker/modules/compiler/manifests/start_sass.pp b/puppet/environment/docker/modules/compiler/manifests/start_sass.pp
@@ -1,15 +1,14 @@
-### Note: the prefix 'compiler::', corresponds to a puppet convention:
 ###
-###       https://github.com/jeff1evesque/machine-learning/issues/2349
+### start_sass.pp, minify scss into css.
 ###
 class compiler::start_sass {
-    # variables
+    ## variables
     $hiera_general   = lookup('general')
     $root_dir        = $hiera_general['root']
     $environment     = $hiera_general['environment']
     $dev_env_path    = "${root_dir}/puppet/environment/${environment}"
 
-    # manually compile: increase default timeout (300s)
+    ## manually compile: increase default timeout (300s)
     exec { 'sass':
         command  => "./sass ${root_dir}",
         cwd      => "${dev_env_path}/modules/compiler/scripts",

diff --git a/puppet/environment/docker/modules/compiler/manifests/start_uglifyjs.pp b/puppet/environment/docker/modules/compiler/manifests/start_uglifyjs.pp
@@ -1,15 +1,14 @@
-### Note: the prefix 'compiler::', corresponds to a puppet convention:
 ###
-###       https://github.com/jeff1evesque/machine-learning/issues/2349
+### start_uglifyjs.pp, minify javascript.
 ###
 class compiler::start_uglifyjs {
-    # variables
+    ## variables
     $hiera_general   = lookup('general')
     $root_dir        = $hiera_general['root']
     $environment     = $hiera_general['environment']
     $dev_env_path    = "${root_dir}/puppet/environment/${environment}"
 
-    # manually compile
+    ## manually compile
     exec { 'uglifyjs':
         command  => "./uglifyjs ${root_dir}",
         cwd      => "${dev_env_path}/modules/compiler/scripts",

diff --git a/puppet/environment/docker/modules/compiler/manifests/webcompilers.pp b/puppet/environment/docker/modules/compiler/manifests/webcompilers.pp
@@ -1,6 +1,5 @@
-### Note: the prefix 'compiler::', corresponds to a puppet convention:
 ###
-###       https://github.com/jeff1evesque/machine-learning/issues/2349
+### webcompilers.pp, create webcompiler services.
 ###
 class compiler::webcompilers {
     ## variables
@@ -31,14 +30,14 @@
     ## define compilers
     $compilers.each |String $compiler| {
         ## dos2unix upstart: convert clrf (windows to linux) in case host
-        #                    machine is windows.
+        ##                   machine is windows.
         file { "/etc/init/${compiler}.conf":
             ensure  => file,
             content => dos2unix(template($template_path)),
         }
 
         ## dos2unix upstart: convert clrf (windows to linux) in case host
-        #                    machine is windows.
+        ##                   machine is windows.
         file { "${compiler_dir}/${compiler}":
             ensure  => file,
             content => dos2unix(template("${compiler_dir}/${compiler}")),

diff --git a/puppet/environment/docker/modules/database/manifests/bindings.pp b/puppet/environment/docker/modules/database/manifests/bindings.pp
@@ -1,6 +1,5 @@
-### Note: the prefix 'database::', corresponds to a puppet convention:
 ###
-###       https://github.com/jeff1evesque/machine-learning/issues/2349
+### bindings.pp, ensure mariadb bindings.
 ###
 class database::bindings {
     class { '::mysql::bindings':

diff --git a/puppet/environment/docker/modules/database/manifests/client.pp b/puppet/environment/docker/modules/database/manifests/client.pp
@@ -1,9 +1,7 @@
-### Note: the prefix 'database::', corresponds to a puppet convention:
 ###
-###       https://github.com/jeff1evesque/machine-learning/issues/2349
+### client.pp, mysql::client: install, and configure mariadb-client.
 ###
 class database::client {
-    ## mysql::client: install, and configure mariadb-client
     class { '::mysql::client':
         package_name => 'mariadb-client',
     }

diff --git a/puppet/environment/docker/modules/database/manifests/database.pp b/puppet/environment/docker/modules/database/manifests/database.pp
@@ -1,6 +1,5 @@
-### Note: the prefix 'database::', corresponds to a puppet convention:
 ###
-###       https://github.com/jeff1evesque/machine-learning/issues/2349
+### database.pp, create mariadb database structure.
 ###
 class database::database {
     ## variables
@@ -13,9 +12,9 @@
     $script_dir      = "${environment_dir}/modules/${module}/scripts"
 
     ## define database tables
-    #
-    #  @require, syntax involves 'Class Containment'. For more information,
-    #      https://puppetlabs.com/blog/class-containment-puppet
+    ##
+    ## @require, syntax involves 'Class Containment'. For more information,
+    ##     https://puppetlabs.com/blog/class-containment-puppet
     exec { 'create-database-tables':
         command => "python setup_tables.py ${root_dir} ${vagrant_mounted}",
         cwd     => $script_dir,

diff --git a/puppet/environment/docker/modules/database/manifests/server.pp b/puppet/environment/docker/modules/database/manifests/server.pp
@@ -1,6 +1,5 @@
-### Note: the prefix 'database::', corresponds to a puppet convention:
 ###
-###       https://github.com/jeff1evesque/machine-learning/issues/2349
+### server.pp, create mariadb database, with user permissions.
 ###
 class database::server {
     ## local variables
@@ -17,10 +16,11 @@
     $bind_address     = $hiera_database['bind_address']
 
     ## mysql::server: install, and configure mariadb-server
-    #
-    #  @password_hash, default password (can be adjusted via cli)
-    #  @max_connections_per_hour, @max_queries_per_hour, @max_updates_per_hour,
-    #      @max_user_connections, a zero value indicates no limit
+    ##
+    ## @password_hash, default password (can be adjusted via cli)
+    ## @max_connections_per_hour, @max_queries_per_hour, @max_updates_per_hour,
+    ## @max_user_connections, a zero value indicates no limit
+    ##
     class { '::mysql::server':
         package_name  => 'mariadb-server',
         root_password => $root_pass,

diff --git a/puppet/environment/docker/modules/package/manifests/fetch.pp b/puppet/environment/docker/modules/package/manifests/fetch.pp
@@ -1,6 +1,5 @@
-### Note: the prefix 'package::', corresponds to a puppet convention:
 ###
-###       https://github.com/jeff1evesque/machine-learning/issues/2349
+### fetch.pp, install package.
 ###
 class package::fetch {
     ## local variables

diff --git a/puppet/environment/docker/modules/package/manifests/flask_script.pp b/puppet/environment/docker/modules/package/manifests/flask_script.pp
@@ -1,6 +1,5 @@
-### Note: the prefix 'package::', corresponds to a puppet convention:
 ###
-###       https://github.com/jeff1evesque/machine-learning/issues/2349
+### flask_script.pp, install package.
 ###
 class package::flask_script {
     require python

diff --git a/puppet/environment/docker/modules/package/manifests/gunicorn.pp b/puppet/environment/docker/modules/package/manifests/gunicorn.pp
@@ -1,6 +1,5 @@
-### Note: the prefix 'package::', corresponds to a puppet convention:
 ###
-###       https://github.com/jeff1evesque/machine-learning/issues/2349
+### gunicorn.pp, install package.
 ###
 class package::gunicorn {
     require python

diff --git a/puppet/environment/docker/modules/package/manifests/inotify_tools.pp b/puppet/environment/docker/modules/package/manifests/inotify_tools.pp
@@ -1,6 +1,5 @@
-### Note: the prefix 'package::', corresponds to a puppet convention:
 ###
-###       https://github.com/jeff1evesque/machine-learning/issues/2349
+### inotify_tools.pp, install package.
 ###
 class package::inotify_tools {
     ## update apt-get

diff --git a/puppet/environment/docker/modules/package/manifests/jsonschema.pp b/puppet/environment/docker/modules/package/manifests/jsonschema.pp
@@ -1,6 +1,5 @@
-### Note: the prefix 'package::', corresponds to a puppet convention:
 ###
-###       https://github.com/jeff1evesque/machine-learning/issues/2349
+### jsonschema.pp, install package.
 ###
 class package::jsonschema {
     include python

diff --git a/puppet/environment/docker/modules/package/manifests/libssl_dev.pp b/puppet/environment/docker/modules/package/manifests/libssl_dev.pp
@@ -1,6 +1,5 @@
-### Note: the prefix 'package::', corresponds to a puppet convention:
 ###
-###       https://github.com/jeff1evesque/machine-learning/issues/2349
+### @libssl_dev.pp, install package.
 ###
 class package::libssl_dev {
     ## update apt-get

diff --git a/puppet/environment/docker/modules/package/manifests/pytest_flask.pp b/puppet/environment/docker/modules/package/manifests/pytest_flask.pp
@@ -1,6 +1,5 @@
-### Note: the prefix 'package::', corresponds to a puppet convention:
 ###
-###       https://github.com/jeff1evesque/machine-learning/issues/2349
+### pytest_flask.pp, install package.
 ###
 class package::pytest_flask {
     require python

diff --git a/puppet/environment/docker/modules/package/manifests/python_dev.pp b/puppet/environment/docker/modules/package/manifests/python_dev.pp
@@ -1,6 +1,5 @@
-### Note: the prefix 'package::', corresponds to a puppet convention:
 ###
-###       https://github.com/jeff1evesque/machine-learning/issues/2349
+### python_dev.pp, install package.
 ###
 class package::python_dev {
     ## update apt-get

diff --git a/puppet/environment/docker/modules/package/manifests/pyyaml.pp b/puppet/environment/docker/modules/package/manifests/pyyaml.pp
@@ -1,6 +1,5 @@
-### Note: the prefix 'package::', corresponds to a puppet convention:
 ###
-###       https://github.com/jeff1evesque/machine-learning/issues/2349
+### pyyaml.pp, install package.
 ###
 class package::pyyaml {
     require python

diff --git a/puppet/environment/docker/modules/package/manifests/react_presets.pp b/puppet/environment/docker/modules/package/manifests/react_presets.pp
@@ -1,14 +1,13 @@
-### Note: the prefix 'package::', corresponds to a puppet convention:
 ###
-###       https://github.com/jeff1evesque/machine-learning/issues/2349
+### react_presets.pp, install necessary webpackages defined in 'package.json'.
 ###
 class package::react_presets {
     ## local variables
     $hiera_general = lookup('general')
     $root_dir      = $hiera_general['root']
 
     ## install babelify presets for reactjs (npm)
-    exec { 'install-babelify-presets':
+    exec { 'install-web-packages':
         command => 'npm install --no-bin-links',
         cwd     => "${root_dir}/src/jsx/",
         path    => '/usr/bin',

diff --git a/puppet/environment/docker/modules/package/manifests/redis_client.pp b/puppet/environment/docker/modules/package/manifests/redis_client.pp
@@ -1,6 +1,5 @@
-### Note: the prefix 'package::', corresponds to a puppet convention:
 ###
-###       https://github.com/jeff1evesque/machine-learning/issues/2349
+### redis_client.pp, install package.
 ###
 class package::redis_client {
     require python

diff --git a/puppet/environment/docker/modules/package/manifests/redis_server.pp b/puppet/environment/docker/modules/package/manifests/redis_server.pp
@@ -1,6 +1,5 @@
-### Note: the prefix 'package::', corresponds to a puppet convention:
 ###
-###       https://github.com/jeff1evesque/machine-learning/issues/2349
+### redis_server.pp, install package.
 ###
 class package::redis_server {
     ## local variables

diff --git a/puppet/environment/docker/modules/package/manifests/scrypt.pp b/puppet/environment/docker/modules/package/manifests/scrypt.pp
@@ -1,6 +1,5 @@
-### Note: the prefix 'package::', corresponds to a puppet convention:
 ###
-###       https://github.com/jeff1evesque/machine-learning/issues/2349
+### scrypt.pp, install package.
 ###
 class package::scrypt {
     require python

diff --git a/puppet/environment/docker/modules/package/manifests/six.pp b/puppet/environment/docker/modules/package/manifests/six.pp
@@ -1,6 +1,5 @@
-### Note: the prefix 'package::', corresponds to a puppet convention:
 ###
-###       https://github.com/jeff1evesque/machine-learning/issues/2349
+### six.pp, install package.
 ###
 class package::six {
     require python

diff --git a/puppet/environment/docker/modules/package/manifests/sklearn.pp b/puppet/environment/docker/modules/package/manifests/sklearn.pp
@@ -1,6 +1,5 @@
-### Note: the prefix 'package::', corresponds to a puppet convention:
 ###
-###       https://github.com/jeff1evesque/machine-learning/issues/2349
+### sklearn.pp, clone github codebase.
 ###
 class package::sklearn {
     require git

diff --git a/puppet/environment/docker/modules/package/manifests/sklearn_dependencies.pp b/puppet/environment/docker/modules/package/manifests/sklearn_dependencies.pp
@@ -1,6 +1,5 @@
-### Note: the prefix 'package::', corresponds to a puppet convention:
 ###
-###       https://github.com/jeff1evesque/machine-learning/issues/2349
+### sklearn_dependencies.pp, install sklearn related packages.
 ###
 class package::sklearn_dependencies {
     ## local variables