puppetlabs / puppetlabs/puppet-strings
Custom facts should be supported
Nobody has claimed this yet.
- Dominant language
- Ruby
- Stars
- 90
- Forks
- 90
- PR merge metrics
- No merged PRs in 30d
Description
Use Case
strings covers almost the entire Puppet module ecosystem with the exception of custom facts. I would like strings to be able to generate documentation for custom facts so that I do not need to reproduce the content by hand.
I understand that some facts are complex but even just noting which ones need to be seen in the README and auto-documenting the rest would be a huge benefit.
Describe the Solution You Would Like
A Custom Facts section is present in the REFERENCE.md
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 the strings documentation-generation entry point and comparing generated output with REFERENCE.md. Determine how custom facts are discovered and represented, then verify that REFERENCE.md contains a Custom Facts section and documents supported facts while identifying any complex facts that still require README coverage.
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
- 30/100