Skip to content

Commit 1679cd0

Browse files
cfawcett82scotje
authored andcommitted
(MAINT) Update install instructions for puppet-agent versus gem install
1 parent aff01d6 commit 1679cd0

File tree

1 file changed

+21
-7
lines changed

1 file changed

+21
-7
lines changed

README.md

Lines changed: 21 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -25,19 +25,33 @@ Puppet Strings generates documentation for Puppet code and extensions written in
2525
### Requirements
2626

2727
* Ruby 2.1.9 or newer
28-
* Puppet 4.0 or newer
29-
* The `yard` Ruby gem
28+
* Puppet 4.0.0 or newer
3029

3130
### Install Puppet Strings
3231

33-
1. Install the YARD gem by running `gem install yard`
34-
1. Install the `puppet-strings` gem by running `gem install puppet-strings`
35-
1. **Optional**: Set YARD options for Strings
32+
Installation instructions vary slightly depending on how you have installed Puppet:
3633

37-
To use YARD options with Puppet Strings, specify a `yardopts` file in the same directory in which you run `puppet strings`. Puppet Strings supports the Markdown format and automatically sets the YARD `markup` option to `markdown`.
34+
#### Installing Puppet Strings with [`puppet-agent`](https://puppet.com/docs/puppet/6.4/about_agent.html#what-puppet-agent-and-puppetserver-are) package
3835

39-
To see a list of available YARD options, run `yard help doc`. For details about YARD options configuration, see the [YARD docs](http://www.rubydoc.info/gems/yard/file/docs/GettingStarted.md#config).
36+
Install the `puppet-strings` gem into the `puppet-agent` environment:
4037

38+
```
39+
sudo /opt/puppetlabs/puppet/bin/gem install puppet-strings
40+
```
41+
42+
#### Installing Puppet Strings with standalone `puppet` gem
43+
44+
Install the `puppet-strings` gem into the same Ruby installation where you have installed the `puppet` gem:
45+
46+
```
47+
gem install puppet-strings
48+
```
49+
50+
### Configure Puppet Strings (Optional)
51+
52+
To use YARD options with Puppet Strings, specify a `.yardopts` file in the same directory in which you run `puppet strings`. Puppet Strings supports the Markdown format and automatically sets the YARD `markup` option to `markdown`.
53+
54+
To see a list of available YARD options, run `yard help doc`. For details about YARD options configuration, see the [YARD docs](http://www.rubydoc.info/gems/yard/file/docs/GettingStarted.md#config).
4155

4256
## Generating documentation with Puppet Strings
4357

0 commit comments

Comments
 (0)