You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository has been archived by the owner on Apr 17, 2023. It is now read-only.
PDK allows validating and unit testing puppet tests and code, but not documentation. Adding an interface to puppet strings that allows both the generation and validation of puppet documentation would greatly simplify the process of writing and maintaining modules both internally and as a community.
I see a pair of spaces that it would be useful to tie strings into:
pdk validate
Running puppet strings generate with output set to none, so the errors/warnings show but the contents aren't generated
pdk strings
This is basically an alias to puppet strings, so that someone can run pdk strings generate to create a REFERENCE.md or to write html docs that can be posted to the github-pages branch of a module.
These two options would allow for testing strings as part of a local test/CI test and then generating the documentation as part of a release workflow/deployment
I'd settle initially for the current litmus treatment, where puppet-strings was available in bundle (at various puppet versions) so that pdk bundle exec puppet strings worked
discuss/acceptedThe feature / request has been accepted for implementation
1 participant
Heading
Bold
Italic
Quote
Code
Link
Numbered list
Unordered list
Task list
Attach files
Mention
Reference
Menu
reacted with thumbs up emoji reacted with thumbs down emoji reacted with laugh emoji reacted with hooray emoji reacted with confused emoji reacted with heart emoji reacted with rocket emoji reacted with eyes emoji
-
PDK allows validating and unit testing puppet tests and code, but not documentation. Adding an interface to puppet strings that allows both the generation and validation of puppet documentation would greatly simplify the process of writing and maintaining modules both internally and as a community.
I see a pair of spaces that it would be useful to tie strings into:
pdk validate
Running
puppet strings generate
with output set to none, so the errors/warnings show but the contents aren't generatedpdk strings
This is basically an alias to puppet strings, so that someone can run pdk strings generate to create a REFERENCE.md or to write html docs that can be posted to the github-pages branch of a module.
These two options would allow for testing strings as part of a local test/CI test and then generating the documentation as part of a release workflow/deployment
I'd settle initially for the current litmus treatment, where puppet-strings was available in bundle (at various puppet versions) so that
pdk bundle exec puppet strings
workedBeta Was this translation helpful? Give feedback.
All reactions