Convert documentation to puppet-strings #1412
Conversation
nginx::config is a classBreaking changes to this file MAY impact these 2 modules (near match):nginx is a classBreaking changes to this file WILL impact these 13 modules (exact match):Breaking changes to this file MAY impact these 33 modules (near match):
nginx::package is a classthat may have no external impact to Forge modules. nginx::package::debian is a classthat may have no external impact to Forge modules. nginx::package::redhat is a classthat may have no external impact to Forge modules. nginx::params is a classBreaking changes to this file MAY impact these 1 modules (near match):nginx::resource::geo is a typethat may have no external impact to Forge modules. nginx::resource::location is a typeBreaking changes to this file WILL impact these 8 modules (exact match):Breaking changes to this file MAY impact these 15 modules (near match):nginx::resource::mailhost is a typethat may have no external impact to Forge modules. nginx::resource::map is a typethat may have no external impact to Forge modules. nginx::resource::server is a typeBreaking changes to this file WILL impact these 10 modules (exact match):Breaking changes to this file MAY impact these 3 modules (near match):nginx::resource::snippet is a typethat may have no external impact to Forge modules. nginx::resource::streamhost is a typethat may have no external impact to Forge modules. nginx::resource::upstream is a typeBreaking changes to this file WILL impact these 1 modules (exact match):Breaking changes to this file MAY impact these 14 modules (near match):nginx::resource::upstream::member is a typethat may have no external impact to Forge modules. nginx::service is a classBreaking changes to this file MAY impact these 1 modules (near match):This module is declared in 10 of 575 indexed public
|
| @@ -102,10 +153,10 @@ | |||
| Optional[String] $ssl_trusted_cert = undef, | |||
| Optional[Integer] $ssl_verify_depth = undef, | |||
| Enum['on', 'off', 'only'] $starttls = 'off', | |||
| $protocol = undef, | |||
| Optional[Enum['imap', 'pop3', 'smtp']] $protocol = undef, | |||
There was a problem hiding this comment.
These are the only values allowed. Previously only documented but https://nginx.org/en/docs/mail/ngx_mail_core_module.html#protocol agrees.
| Optional[String] $auth_http = undef, | ||
| Optional[String] $auth_http_header = undef, | ||
| String $xclient = 'on', | ||
| Enum['on', 'off'] $xclient = 'on', |
There was a problem hiding this comment.
Same here: previously documented and docs agree: https://nginx.org/en/docs/mail/ngx_mail_proxy_module.html#xclient
|
Updated, didn't realize there was some test passing in an invalid value. |
|
Should have read more carefully, the other one was exactly the same situation. |
|
I want to keep the parameter types out and leave that to #1413, will update later. |
There was a problem hiding this comment.
Awesome work @ekohl !!
Have you tested generating a REFERENCE.md?
While this isn't perfect, it's a huge step in the direction.
|
Rebased to resolve conflicts. I did generate one and it looks ok. I think this should now be merged and someone with time should further look into completing the documentation. |
|
Old stuff was recently dropped - do you all want to merge as is or rebase and let test on w/o CentOS 6 and with Puppet 7? |
|
I'm going to merge it to finally have this in master. |
While this isn't perfect, it's a huge step in the direction.