puppetlabs / puppetlabs/puppetlabs-apache
using wsgi_daemon_process_options logs a deprecation warning but the docs only show the deprecated usage
- Dominant language
- Puppet
- Stars
- 356
- Forks
- 1.1k
- Avg merge
- 3m
- Merged PRs (30d)
- 1
Description
With any recent version of puppetlabs-apache, in manifests/vhost.pp there is this section of code:
if $wsgi_daemon_process_options {
deprecation('apache::vhost::wsgi_daemon_process_options', 'This parameter is deprecated. Please add values inside Hash `wsgi_daemon_process`.')
}
This triggers a (huge) deprecation warning log message in the puppetserver.log.
The intent seems to be to switch from using the related wsgi_daemon_process option as a string, and instead make it a Hash, likely with the key/value pairs that were being passed in wsgi_daemon_process_options.
The problem is that the documentation doesn't reflect the deprecation. The reference documentation only shows the deprecated usage, not the preferred usage.
Without updated documentation, it's not clear how the String that was the argument to the deprecated use of wsgi_daemon_process is supposed to be incorporated into preferred format Hash.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading the wsgi_daemon_process_options deprecation in manifests/vhost.pp and locate the reference documentation that describes these parameters. Update the documentation to show the preferred wsgi_daemon_process Hash form and explain how the existing string values are represented; done means the deprecated-only example is no longer the sole guidance.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100