From 9d18af411438645dfd09a12cd993d44f7b0ef196 Mon Sep 17 00:00:00 2001 From: Will Hopper Date: Fri, 2 Dec 2016 11:19:56 -0800 Subject: [PATCH 1/2] (PDOC-143) Add installation instructions for PE 3.8 in Windows --- README.md | 20 +++++++++++++++++--- 1 file changed, 17 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 94e8bcb..6d3bf08 100644 --- a/README.md +++ b/README.md @@ -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`. From 30ffd147f160bbc988f514e3a8c59819fd6afb68 Mon Sep 17 00:00:00 2001 From: Will Hopper Date: Fri, 2 Dec 2016 11:32:16 -0800 Subject: [PATCH 2/2] (maint) Turn off unnecessary rubocop Bundler warnings --- .rubocop.yml | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/.rubocop.yml b/.rubocop.yml index e58d55c..91b2a9f 100644 --- a/.rubocop.yml +++ b/.rubocop.yml @@ -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