puppetlabs / puppetlabs/puppet-strings
Docs with Data Type Aliases without Data Type will not generate lists
Open
Nobody has claimed this yet.
bug
- Dominant language
- Ruby
- Stars
- 90
- Forks
- 90
- PR merge metrics
- No merged PRs in 30d
Description
Documentation containing data type aliases without any data types will not generate puppet_data_type_list.html and the left navigation iframe will contain 404 not found error when on Data Type Alias documentation page. Also the top navigation will be missing Data Types section.
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
Reproduce the issue with documentation containing data type aliases but no data types, then trace how puppet_data_type_list.html and the left navigation iframe are generated. Verify the Data Type Alias page no longer links to a 404 and that the top navigation includes the Data Types section.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- ruby
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100