kienan
/
puppet-strings
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Merge pull request #130 from whopper/PDOC-143/windows-readme 

(PDOC-143) Add installation instructions for PE 3.8 in Windows
This commit is contained in:
Jesse Scott 2016-12-02 12:17:03 -08:00 committed by GitHub
parent 1bd8575acb 30ffd147f1
commit 5ae446fcba
2 changed files with 25 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
.rubocop.yml
View File

@ -4,6 +4,14 @@ AllCops:
- '**/*.erb'
- 'lib/puppet-strings/yard/templates/**/*'
# DISABLED - not useful
Bundler/OrderedGems:
Enabled: false
# DISABLED - Doesn't understand conditionals that result in different versions of a gem.
Bundler/DuplicatedGem:
Enabled: false
Lint/ConditionPosition:
Enabled: true

20
README.md
View File

@ -49,13 +49,20 @@ For Puppet 3.x:
$ puppet resource package yard provider=gem
```
For Puppet Enterprise 3.8:
For Puppet Enterprise 3.8 (Linux):
```
GEM_HOME=/opt/puppet/lib/ruby/gems/1.9.1 puppet resource package yard provider=gem
```
### 2. Puppet Enterprise 3.8 only: Install the redcarpet gem
For Puppet Enterprise 3.8 (Windows):
```
$env:GEM_HOME = "C:\Program Files\Puppet Labs\Puppet Enterprise\sys\ruby\lib\ruby\gems\2.0.0"
puppet resource package yard provider=gem
```
### 2. Puppet Enterprise 3.8 in Linux only: Install the redcarpet gem
```
GEM_HOME=/opt/puppet/lib/ruby/gems/1.9.1 puppet resource package redcarpet provider=gem
@ -77,12 +84,19 @@ For Puppet 3.x:
$ puppet resource package puppet-strings provider=gem
```
For Puppet Enterprise 3.8:
For Puppet Enterprise 3.8 (Linux):
```
GEM_HOME=/opt/puppet/lib/ruby/gems/1.9.1 puppet resource package puppet-strings provider=gem
```
For Puppet Enterprise 3.8 (Windows)
```
$env:GEM_HOME = "C:\Program Files\Puppet Labs\Puppet Enterprise\sys\ruby\lib\ruby\gems\2.0.0"
puppet resource package puppet-strings provider=gem
```
### 4. Optional: Set YARD options for Strings
Puppet Strings supports YARD options (on the command line, run `yard help doc` for a list of possible options. To set YARD options, specify a `yardopts` file in the same directory in which you run `puppet strings`.