This text is adapted from JEP-2 and is intended as writing prompts for PRFC proposals. Any of the sections not flagged as REQUIRED is optional.
REQUIRED -- Provide a one-paragraph summary of the proposal, no more than a few sentences. This summary will be rolled up into feature lists and other documents, so please take the time to make it short and sweet.
REQUIRED -- Why should this work be done? What are the problems it is attempting to address and who experiences those problems? (Is it every Puppet installation in the world? Only ones which operate under particular conditions? Only people attempting to extend Puppet?)
Describe any goals you wish to identify specifically as being out of scope for this proposal.
REQUIRED -- Describe the enhancement in detail: Both what it is and, to the extent understood, how you intend to implement it. Summarize, at a high level, all of the interfaces you expect to modify or extend, including APIs, command-line switches, network protocols, and file formats. Explain how failures in applications using this enhancement will be diagnosed, both during development and in production. Describe any open design issues.
This section will evolve over time as the work progresses, ultimately becoming the authoritative high-level description of the end result. Include hyperlinks to additional documents as required.
Are there existing implementations either in the Puppet ecosystem or more broadly in the domain this is attempting to address which we should consider, learn from, or possibly adopt wholesale?
Are there other approaches that we should consider?
How will this work impact other parts of the platform, the product, and the contributors working on them?
- Other Puppet components: ...
- Compatibility: ...
- Security: ...
- Performance/scalability: ...
- User experience: ...
- I18n/L10n: ...
- Accessibility: ...
- Portability: ...
- Packaging/installation: ...
- Documentation: ...
- Spin-offs/Future work: ...
- Other: ...