puppetlabs / puppetlabs/puppet-resource_api
Restructure puppet-specifications reference for better flow
Open
@clairecadman is already working on this.
Since Sep 24, 2019.
documentation
enhancement
- Dominant language
- Ruby
- Stars
- 27
- Forks
- 42
- PR merge metrics
- No merged PRs in 30d
Description
Describe the Change You Would Like
The specs at https://github.com/puppetlabs/puppet-specifications/blob/master/language/resource-api/README.md have started to contain forward references and deep indentation. To improve legibility come up with a better structure to optimize for top-to-bottom reading. This is also a good opportunity to go through and crisp up a few words that have specific meanings and make sure they're defined once and then used consistently throughout.
This was originally filed as https://tickets.puppetlabs.com/browse/MODULES-9430
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.
Assessment
This issue has not been assessed yet.