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

Update inline doc to puppet-strings #172

Merged
merged 5 commits into from
Jan 13, 2017
Merged

Update inline doc to puppet-strings #172

merged 5 commits into from
Jan 13, 2017

Conversation

vinzent
Copy link
Contributor

@vinzent vinzent commented Jan 13, 2017

  • puppet strings requires redcarpet gem to convert markdown to html
  • Github Pages require the docs to be in the docs/ folder
  • the docs can be generated with: bundle exec rake strings:generate

@vinzent vinzent changed the title Update inline doc to puppet-strings (WIP) Update inline doc to puppet-strings Jan 13, 2017
@rnelson0
Copy link
Member

What does redcarpet do, and how was docs/ generated? It seems like we need a rake task to automate this, and/or a blog post to go with it.

@vinzent
Copy link
Contributor Author

vinzent commented Jan 13, 2017

@rnelson0 redcarpet converts markdown to html , there is a strings rake target already: bundle exec rake strings:generate

@vinzent vinzent changed the title (WIP) Update inline doc to puppet-strings Update inline doc to puppet-strings Jan 13, 2017
@bastelfreak bastelfreak merged commit 2fae8d0 into voxpupuli:master Jan 13, 2017
EmRowlands pushed a commit to EmRowlands/puppet-selinux that referenced this pull request Mar 29, 2023
Update inline doc to puppet-strings
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants