puppetlabs / control-repo

A control repository template
Apache License 2.0
204 stars 510 forks source link

Moved the roles and profile comments to the top #112

Closed 16c7x closed 1 year ago

16c7x commented 1 year ago

The new training courses (and the old Practitioner) are telling students to run a pdk convert in the roles module and the profiles module and then test new role and profile classes using pdk validate, this results in warnings;

pdk (WARNING): puppet-lint: class not documented (manifests/database_server.pp:1:1)
pdk (WARNING): puppet-lint: class not documented (manifests/webserver.pp:1:1)
pdk (WARNING): puppet-lint: class not documented (manifests/example.pp:1:1)

and

pdk (WARNING): puppet-lint: class not documented (manifests/example.pp:1:1)
pdk (WARNING): puppet-lint: class not documented (manifests/base.pp:1:1)

This seems reasonable, the roles and profiles modules are just modules and should follow the same rules. I'm expecting students will probably take this process back to their own environments. I've moved the comments (where they exist or added new ones) to the top of the class files to clear the WARNING messages and make things a bit tidier. We shouldn't be delivering a template that generates PDK warnings.