Merge pull request #15 from github/kpaulisse-document-hiera-correctly

hiera_yaml_file -> hiera_config everywhere

Author: kpaulisse

doc/configuration.md

@@ -30,7 +30,7 @@
 
   To be minimally functional, you will almost certainly need to define at least the following settings:
 
-  - `settings[:hiera_yaml_file]` as the absolute or relative path to your hiera configuration file
+  - `settings[:hiera_config]` as the absolute or relative path to your hiera configuration file
   - `settings[:hiera_path_strip]` as the prefix to strip when munging the hiera configuration file
   - `settings[:puppetdb_url]` as the URL to your PuppetDB instance so facts can be obtained
 

examples/octocatalog-diff.cfg.rb

@@ -26,15 +26,15 @@ def self.config
       settings = {}
 
       ##############################################################################################
-      # hiera_yaml_file
+      # hiera_config
       #   Path to the hiera.yaml configuration file. If the path starts with a `/`, then it is
       #   treated as an absolute path on this system. Otherwise, the path will be treated as
       #   a relative path. If you don't specify this, the tool will assume you aren't using Hiera.
       #   More: https://github.com/github/octocatalog-diff/blob/master/doc/configuration-hiera.md
       ##############################################################################################
 
-      # settings[:hiera_yaml_file] = '/etc/puppetlabs/puppet/hiera.yaml' # Absolute path
-      # settings[:hiera_yaml_file] = 'environments/production/config/hiera.yaml' # Relative path
+      # settings[:hiera_config] = '/etc/puppetlabs/puppet/hiera.yaml' # Absolute path
+      # settings[:hiera_config] = 'environments/production/config/hiera.yaml' # Relative path
 
       ##############################################################################################
       # hiera_path_strip