Add notes about trailing slashes

Kevin Paulisse · Kevin Paulisse · commit 6bb25f91263c · 2016-11-17T14:51:51.000-08:00
diff --git a/doc/advanced-hiera-path-stripping.md b/doc/advanced-hiera-path-stripping.md
@@ -37,3 +37,5 @@ bin/octocatalog-diff --hiera-config hiera.yaml --hiera-path-strip /etc/puppetlab
 :yaml:
   :datadir: /var/tmp/puppet-compile-dir-92347829847/environments/%{environment}/hieradata
 ```
+
+:warning: Be sure that you do NOT include a trailing slash on `--hiera-path-strip` or `settings[:hiera_path_strip]`.
diff --git a/examples/octocatalog-diff.cfg.rb b/examples/octocatalog-diff.cfg.rb
@@ -56,6 +56,7 @@ def self.config
       #      In this case, you desire to strip `/etc/puppetlabs/code` from the beginning of the path,
       #      in order that octocatalog-diff can find your hiera datafiles in the compilation
       #      location, which is {temporary directory}/environments/production/hieradata.
+      #      If you use this, be sure that you do NOT include a trailing slash!
       #
       #      More: https://github.com/github/octocatalog-diff/blob/master/doc/configuration-hiera.md
       ##############################################################################################

Original file line number	Diff line number	Diff line change
`@@ -56,6 +56,7 @@ def self.config`
`56`	`56`	# In this case, you desire to strip `/etc/puppetlabs/code` from the beginning of the path,
`57`	`57`	`# in order that octocatalog-diff can find your hiera datafiles in the compilation`
`58`	`58`	`# location, which is {temporary directory}/environments/production/hieradata.`
	`59`	`+ # If you use this, be sure that you do NOT include a trailing slash!`
`59`	`60`	`#`
`60`	`61`	`# More: https://github.com/github/octocatalog-diff/blob/master/doc/configuration-hiera.md`
`61`	`62`	`##############################################################################################`