New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Move examples and params to puppet strings style docs #562
Conversation
Let's also wait to merge this until some of the other changes are merged, don't want to create nasty rebase hell. Other than that, though, I think this should be pretty safe. |
Aw shoot sorry, I just saw this PR I will make sure to look it over this week! |
@HAIL9000 thanks! Ping me on Slack or IRC sometime if you want to discuss more (and I'll try to rebase as well). I think the big question is where the examples should go... I'm leaning towards that they should go in the types / providers they correspond with, but then I'm worried that they'll get buried unless there's some tooling to generate a README. |
53fe5cc
to
d6df3a6
Compare
One other thing I noticed -- moving examples out of README doesn't let us do:
as best I can tell. Is there a way (in puppet strings) to set the code type? |
Rebased |
9c0ff81
to
63f5f26
Compare
@HAIL9000 how's this? As discussed on IRC, moved the examples for types back to the corresponding types, and left most of those examples in the README as well. I'm getting some warnings (maybe related to https://tickets.puppetlabs.com/browse/PDOC-126 )
Is there a fix in terms of quoting that will fix this? Quoting the heredoc didn't make a difference. Still some missing docs for parameters / etc., but can fix this iteratively. |
Add back a few examples removed in #562
Move examples and params to puppet strings style docs
Add back a few examples removed in voxpupuli#562
Move examples and params to puppet strings style docs
Add back a few examples removed in voxpupuli#562
This is a first pass at moving docs to puppet-strings, starting with params and examples. Only bad thing is that we might want to move some of the params that aren't os specific back to init.pp at some point, so that it's easier to see default params in the docs.