create puppet strings based reference docs #209
Conversation
your1p
changed the title
your1p
changed the title
| @@ -1,5 +1,53 @@ | |||
| # == Class keepalived | |||
| # | |||
| # @param sysconf_dir | |||
There was a problem hiding this comment.
Since init.pp is potentially the first contact with module by a reader, can you add informations about parameters ?
manifests/lvs/real_server.pp
Outdated
| @@ -1,25 +1,21 @@ | |||
| # == Define: keepalived::lvs::real_server | |||
| # Define Keepalived::Lvs::Real_server | |||
There was a problem hiding this comment.
It looks clearer to use the sentence of the summary rather that this.
manifests/lvs/virtual_server.pp
Outdated
| @@ -11,107 +11,115 @@ | |||
| # Refer to keepalived's documentation to understand the behaviour | |||
manifests/lvs/virtual_server.pp
Outdated
| # Virtual Server firewall mark. (overrides ip_address and port) | ||
| # Default: not set | ||
| # | ||
| # [*lb_algo*] | ||
| # @param lb_algo | ||
| # Must be one of rr, wrr, lc, wlc, lblc, sh, dh | ||
| # Default: not set. |
There was a problem hiding this comment.
Since we are using puppet-string the default values are auto-generated. Giving this information by a manual description can be not what is in the code. So please remove them.
manifests/vrrp/instance.pp
Outdated
| @@ -1,167 +1,198 @@ | |||
| # == Define: keepalived::vrrp::instance | |||
| # @summary keepalived::vrrp::instance | |||
There was a problem hiding this comment.
It is possible to describe the type by a sentence like a description ?
manifests/vrrp/script.pp
Outdated
| @@ -1,32 +1,28 @@ | |||
| # == Define: keepalived::vrrp::script | |||
| # @summary keepalived::vrrp::script | |||
There was a problem hiding this comment.
Is it possible to use a sentence more descriptive ?
manifests/vrrp/sync_group.pp
Outdated
| @@ -1,29 +1,27 @@ | |||
| # == Define: keepalived::vrrp::sync_group | |||
| # @summary keepalived::vrrp::sync_group | |||
There was a problem hiding this comment.
Same question here about summary.
manifests/vrrp/track_process.pp
Outdated
| @@ -1,24 +1,20 @@ | |||
| # == Define: keepalived::vrrp::track_process | |||
| # @summary keepalived::vrrp::track_process | |||
| @@ -1 +1,3 @@ | |||
| # @summary keepalived::options | |||
There was a problem hiding this comment.
The type is not this but Keepalived::Options but explaining what is describing the data type is better.
| @@ -1,3 +1,5 @@ | |||
| # @summary keepalived::vrrp::instance::vrule | |||
|
Dear @your1p, thanks for the PR! This is pccibot, your friendly Vox Pupuli GitHub Bot. I noticed that your pull request contains merge conflict. Can you please rebase? You can find my sourcecode at voxpupuli/vox-pupuli-tasks |
1 similar comment
|
Dear @your1p, thanks for the PR! This is pccibot, your friendly Vox Pupuli GitHub Bot. I noticed that your pull request contains merge conflict. Can you please rebase? You can find my sourcecode at voxpupuli/vox-pupuli-tasks |
bastelfreak
force-pushed
the
create-puppet-strings-based-reference-docs
branch
from
2ae8404
to
3b62dd2
Compare
|
I did a rebase and will merge this as is. Whoever likes it can add improvements later on. |
Pull Request (PR) description
Create puppet strings based reference docs.
This Pull Request (PR) fixes the following issues
Fixes #158