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

Add PuppetStrings(YARD) doc standard for Puppet #35

Open
1 of 5 tasks
run2cmd opened this issue Aug 2, 2019 · 4 comments
Open
1 of 5 tasks

Add PuppetStrings(YARD) doc standard for Puppet #35

run2cmd opened this issue Aug 2, 2019 · 4 comments
Assignees
Labels
feature New feature or request

Comments

@run2cmd
Copy link

run2cmd commented Aug 2, 2019

Documentation standard
Puppet Strings

How popular is the doc standard?

  • Not popular at all
  • Some people use it
  • Quite a lot of people use it
  • It's not the most popular one, but a good alternative
  • Everyone is using it

It is strongly based on YARD: https://github.com/puppetlabs/puppet-strings. This is standard that Puppet code use. I think best examples are here: https://puppet.com/docs/puppet/6.7/puppet_strings_style.html

@run2cmd run2cmd added the feature New feature or request label Aug 2, 2019
@kkoomen kkoomen self-assigned this Aug 2, 2019
@kkoomen
Copy link
Owner

kkoomen commented Aug 2, 2019

@run2cmd Is Puppet considered a framework or a new language? Since it uses ruby syntax and even uses .rb files. Can you explain a bit more about these parts?

@run2cmd
Copy link
Author

run2cmd commented Aug 5, 2019

Puppet is a open-core software configuration management tool that follow principle everything as a code. It was written in ruby at the beginning but now it has parts in Clojure and C++ also.

I would treat it as a new language however it is DSL not GPL. Puppet modules does use .rb files for Rspec tests, custom addons/plugins/facts, and .erb files for templates, however Puppet code files are .pp extension.

Those .pp files are those that use Puppet-Strings documentation.

@kkoomen
Copy link
Owner

kkoomen commented Aug 5, 2019

Do you suggest me to use the .pp file extension or .rb? I presume I should use .pp?

@run2cmd
Copy link
Author

run2cmd commented Aug 7, 2019

Yes .pp it should be. .rb Should be treated as Ruby(YARD) which DoGe already supports.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants