Merge pull request #112 from 16c7x/class_documentation

binford2k · web-flow · commit 565607dc6b2c · 2022-09-22T11:14:48.000-07:00
Moved the roles and profile comments to the top
diff --git a/site-modules/profile/manifests/base.pp b/site-modules/profile/manifests/base.pp
@@ -1,5 +1,4 @@
+# The base profile should include component modules that will be on all nodes
 class profile::base {
 
-  #the base profile should include component modules that will be on all nodes
-
 }
diff --git a/site-modules/profile/manifests/example.pp b/site-modules/profile/manifests/example.pp
@@ -1,3 +1,4 @@
+# An example profile
 class profile::example {
 
 }
diff --git a/site-modules/role/manifests/database_server.pp b/site-modules/role/manifests/database_server.pp
@@ -1,7 +1,7 @@
+# This role would be made of all the profiles that need to be included to make a database server work
+# All roles should include the base profile
 class role::database_server {
 
-  #This role would be made of all the profiles that need to be included to make a database server work
-  #All roles should include the base profile
   include profile::base
 
 }
diff --git a/site-modules/role/manifests/example.pp b/site-modules/role/manifests/example.pp
@@ -1,3 +1,4 @@
+# An example role
 class role::example {
 
 }
diff --git a/site-modules/role/manifests/webserver.pp b/site-modules/role/manifests/webserver.pp
@@ -1,7 +1,7 @@
+# This role would be made of all the profiles that need to be included to make a webserver work
+# All roles should include the base profile
 class role::webserver {
 
-  #This role would be made of all the profiles that need to be included to make a webserver work
-  #All roles should include the base profile
   include profile::base
 
 }

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,4 @@`
	`1`	`+# The base profile should include component modules that will be on all nodes`
`1`	`2`	`class profile::base {`
`2`	`3`
`3`		`- #the base profile should include component modules that will be on all nodes`
`4`		`-`
`5`	`4`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+# An example profile`
`1`	`2`	`class profile::example {`
`2`	`3`
`3`	`4`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
	`1`	`+# This role would be made of all the profiles that need to be included to make a database server work`
	`2`	`+# All roles should include the base profile`
`1`	`3`	`class role::database_server {`
`2`	`4`
`3`		`- #This role would be made of all the profiles that need to be included to make a database server work`
`4`		`- #All roles should include the base profile`
`5`	`5`	`include profile::base`
`6`	`6`
`7`	`7`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+# An example role`
`1`	`2`	`class role::example {`
`2`	`3`
`3`	`4`	`}`