puppetlabs / puppetlabs/puppet-resource_api
Add all ruby code to puppet-strings output
Nobody has claimed this yet.
- Dominant language
- Ruby
- Stars
- 27
- Forks
- 42
- PR merge metrics
- No merged PRs in 30d
Description
Use Case
To cover the entirety of code from Resource API resources, puppet-strings should also include parsing and documenting the ruby code of the provider. This will improve visibility of the code comments and make puppet-strings output more useful.
Additional Context
Originally raised as https://tickets.puppetlabs.com/browse/PDK-902
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 tracing how puppet-strings currently parses Resource API resources and produces its output, then compare that path with the Ruby provider code described in the issue. Done means provider Ruby code is parsed and its comments appear in puppet-strings output, with coverage for the affected Resource API cases.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- ruby
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100