Merge pull request #5 from voxpupuli/docs

Add types and documentation for all parameters

.puppet-lint.rc

@@ -1,3 +1 @@
 --fail-on-warnings
---no-parameter_documentation-check
---no-parameter_types-check

.sync.yml

@@ -0,0 +1,5 @@
+---
+.puppet-lint.rc:
+  enabled_lint_checks:
+    - parameter_documentation
+    - parameter_types

REFERENCE.md

@@ -91,63 +91,63 @@ The following parameters are available in the `bolt::project` defined type:
 
 Data type: `Stdlib::Absolutepath`
 
-
+rootdir where the project will be created into
 
 Default value: `'/opt/'`
 
 ##### <a name="-bolt--project--project"></a>`project`
 
 Data type: `String[1]`
 
-
+the name of the project
 
 Default value: `$name`
 
 ##### <a name="-bolt--project--owner"></a>`owner`
 
 Data type: `String[1]`
 
-
+the user that will own the files and run the service
 
 Default value: `$project`
 
 ##### <a name="-bolt--project--group"></a>`group`
 
 Data type: `String[1]`
 
-
+the group for all files
 
 Default value: `$project`
 
 ##### <a name="-bolt--project--manage_user"></a>`manage_user`
 
 Data type: `Boolean`
 
-
+if we should create the user+group or not
 
 Default value: `true`
 
 ##### <a name="-bolt--project--plans"></a>`plans`
 
 Data type: `Array[String[1]]`
 
-
+a list of all plans we want to run
 
 Default value: `[]`
 
 ##### <a name="-bolt--project--environment"></a>`environment`
 
 Data type: `String[1]`
 
-
+the desired code environment we will use
 
 Default value: `'peadm'`
 
 ##### <a name="-bolt--project--modulepaths"></a>`modulepaths`
 
 Data type: `Array[Stdlib::Absolutepath]`
 
-
+an array of directories where code lives
 
 Default value: `["/etc/puppetlabs/code/environments/${environment}/modules", "/etc/puppetlabs/code/environments/${environment}/site",]`
 

manifests/project.pp

@@ -1,8 +1,14 @@
 #
 # @summary creates required files for a bolt project. Will create one oneshot service for each plan
 #
-# @param basepath
-# @param project
+# @param basepath rootdir where the project will be created into
+# @param project the name of the project
+# @param owner the user that will own the files and run the service
+# @param group the group for all files
+# @param manage_user if we should create the user+group or not
+# @param plans a list of all plans we want to run
+# @param environment the desired code environment we will use
+# @param modulepaths an array of directories where code lives
 #
 # @author Tim Meusel <[email protected]>
 #