voxpupuli / puppet-zabbix

Puppet module for creating and maintaining zabbix components with puppet.
https://forge.puppet.com/puppet/zabbix
Apache License 2.0
80 stars 227 forks source link

add documentation to satisfy linting #866

Closed Phil-Friderici closed 1 year ago

Phil-Friderici commented 1 year ago

Pull Request (PR) description

fix: add documentation to satisfy linting

Fixes the following warnings that do pop up while linting:

[warn]: Missing documentation for Puppet type alias 'Zabbix::Historyics' at types/historyics.pp:1.
[warn]: Missing a description for Puppet resource property 'ensure' at lib/puppet/type/zabbix_host.rb:4.
[warn]: Missing a description for Puppet resource property 'ensure' at lib/puppet/type/zabbix_proxy.rb:4.
[warn]: Missing a description for Puppet resource property 'ensure' at lib/puppet/type/zabbix_template.rb:4.
[warn]: Missing a description for Puppet resource property 'ensure' at lib/puppet/type/zabbix_hostgroup.rb:6.
[warn]: Missing a description for Puppet resource property 'ensure' at lib/puppet/type/zabbix_application.rb:15.
[warn]: Missing a description for Puppet provider 'ruby' (resource type 'zabbix_host') at lib/puppet/provider/zabbix_host/ruby.rb:4.
[warn]: Missing a description for Puppet resource property 'ensure' at lib/puppet/type/zabbix_template_host.rb:14.
[warn]: Missing a description for Puppet provider 'ruby' (resource type 'zabbix_proxy') at lib/puppet/provider/zabbix_proxy/ruby.rb:4.
[warn]: Missing a description for Puppet resource property 'ensure' at lib/puppet/type/zabbix_userparameters.rb:5.
[warn]: Missing a description for Puppet provider 'ruby' (resource type 'zabbix_template') at lib/puppet/provider/zabbix_template/ruby.rb:4.
[warn]: Missing a description for Puppet provider 'ruby' (resource type 'zabbix_hostgroup') at lib/puppet/provider/zabbix_hostgroup/ruby.rb:4.
[warn]: Missing a description for Puppet provider 'ruby' (resource type 'zabbix_application') at lib/puppet/provider/zabbix_application/ruby.rb:4.
[warn]: Missing a description for Puppet provider 'ruby' (resource type 'zabbix_template_host') at lib/puppet/provider/zabbix_template_host/ruby.rb:4.
[warn]: Missing a description for Puppet provider 'ruby' (resource type 'zabbix_userparameters') at lib/puppet/provider/zabbix_userparameters/ruby.rb:4.
Phil-Friderici commented 1 year ago

The errors on ArchLinx are caused by puppetlabs-postgresql module. The postgresql module is missing a valid default value for $service_status on ArchLinux.

I have created an issue to get it fixed.