Skip to content
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

Merged
merged 1 commit into from Sep 9, 2017

Conversation

wyardley
Copy link
Contributor

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.

@wyardley
Copy link
Contributor Author

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.

@HAIL9000
Copy link
Member

HAIL9000 commented Sep 6, 2017

Aw shoot sorry, I just saw this PR I will make sure to look it over this week!

@wyardley
Copy link
Contributor Author

wyardley commented Sep 6, 2017

@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.

@wyardley wyardley force-pushed the strings branch 2 times, most recently from 53fe5cc to d6df3a6 Compare September 6, 2017 22:42
@wyardley
Copy link
Contributor Author

wyardley commented Sep 6, 2017

One other thing I noticed -- moving examples out of README doesn't let us do:

 ```puppet

as best I can tell. Is there a way (in puppet strings) to set the code type?

@wyardley
Copy link
Contributor Author

wyardley commented Sep 6, 2017

Rebased

@wyardley wyardley removed the needs-feedback Further information is requested label Sep 8, 2017
@wyardley
Copy link
Contributor Author

wyardley commented Sep 8, 2017

@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 )

[warn]: In file `manifests/init.pp':0: Cannot resolve link to foo, from text:
	...{foo, baz}...
[warn]: In file `lib/puppet/type/rabbitmq_queue.rb':1: Cannot resolve link to x-message-ttl from text:
	...{x-message-ttl => 60, x-expires => 10}...
[warn]: In file `lib/puppet/type/rabbitmq_erlang_cookie.rb':6: Cannot resolve link to rabbitmq_home from text:
	...{rabbitmq_home}...
[warn]: In file `lib/puppet/type/rabbitmq_erlang_cookie.rb':6: Cannot resolve link to rabbitmq_home from text:
	...{rabbitmq_home}...

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.

@wyardley wyardley added docs Improvements or additions to documentation enhancement New feature or request labels Sep 8, 2017
@wyardley wyardley merged commit 555a3c6 into voxpupuli:master Sep 9, 2017
wyardley pushed a commit to wyardley/puppet-rabbitmq that referenced this pull request Sep 9, 2017
bastelfreak added a commit that referenced this pull request Sep 9, 2017
Add back a few examples removed in #562
@wyardley wyardley deleted the strings branch September 9, 2017 23:29
Slm0n87 pushed a commit to Slm0n87/puppet-rabbitmq that referenced this pull request Mar 7, 2019
Move examples and params to puppet strings style docs
Slm0n87 pushed a commit to Slm0n87/puppet-rabbitmq that referenced this pull request Mar 7, 2019
Slm0n87 pushed a commit to Slm0n87/puppet-rabbitmq that referenced this pull request Mar 7, 2019
cegeka-jenkins pushed a commit to cegeka/puppet-rabbitmq that referenced this pull request Mar 26, 2021
Move examples and params to puppet strings style docs
cegeka-jenkins pushed a commit to cegeka/puppet-rabbitmq that referenced this pull request Mar 26, 2021
cegeka-jenkins pushed a commit to cegeka/puppet-rabbitmq that referenced this pull request Mar 26, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants