CHEF-5468 Correct heading level in output docs yaml files (#962)

Signed-off-by: Ian Maddaus <[email protected]>
chef · Aug 25, 2023 · 2971520 · 2971520
1 parent 39c45fd
commit 2971520
Show file tree

Hide file tree

Showing 497 changed files with 853 additions and 853 deletions.
diff --git a/docs-chef-io/assets/cookstyle/cops_chef_correctness_blockguardwithonlystring.yml b/docs-chef-io/assets/cookstyle/cops_chef_correctness_blockguardwithonlystring.yml
@@ -9,7 +9,7 @@ autocorrection: true
 target_chef_version: All Versions
 examples: |2-
 
-  #### incorrect
+  ### incorrect
 
   ```ruby
   template '/etc/foo' do
@@ -19,7 +19,7 @@ examples: |2-
   end
   ```
 
-  #### correct
+  ### correct
 
   ```ruby
   template '/etc/foo' do

diff --git a/docs-chef-io/assets/cookstyle/cops_chef_correctness_chefapplicationfatal.yml b/docs-chef-io/assets/cookstyle/cops_chef_correctness_chefapplicationfatal.yml
@@ -8,13 +8,13 @@ autocorrection: true
 target_chef_version: All Versions
 examples: |2-
 
-  #### incorrect
+  ### incorrect
 
   ```ruby
   Chef::Application.fatal!('Something horrible happened!')
   ```
 
-  #### correct
+  ### correct
 
   ```ruby
   raise "Something horrible happened!"

diff --git a/docs-chef-io/assets/cookstyle/cops_chef_correctness_conditionalrubyshellout.yml b/docs-chef-io/assets/cookstyle/cops_chef_correctness_conditionalrubyshellout.yml
@@ -9,7 +9,7 @@ autocorrection: true
 target_chef_version: All Versions
 examples: |2-
 
-  #### incorrect
+  ### incorrect
 
   ```ruby
   cookbook_file '/logs/foo/error.log' do
@@ -23,7 +23,7 @@ examples: |2-
   end
   ```
 
-  #### correct
+  ### correct
 
   ```ruby
   cookbook_file '/logs/foo/error.log' do

diff --git a/docs-chef-io/assets/cookstyle/cops_chef_correctness_cookbookusesnodesave.yml b/docs-chef-io/assets/cookstyle/cops_chef_correctness_cookbookusesnodesave.yml
@@ -10,7 +10,7 @@ autocorrection: false
 target_chef_version: All Versions
 examples: |2-
 
-  #### incorrect
+  ### incorrect
 
   ```ruby
   node.save

diff --git a/docs-chef-io/assets/cookstyle/cops_chef_correctness_dnfpackageallowdowngrades.yml b/docs-chef-io/assets/cookstyle/cops_chef_correctness_dnfpackageallowdowngrades.yml
@@ -7,7 +7,7 @@ autocorrection: true
 target_chef_version: All Versions
 examples: |2-
 
-  #### incorrect
+  ### incorrect
 
   ```ruby
   dnf_package 'nginx' do
@@ -16,7 +16,7 @@ examples: |2-
   end
   ```
 
-  #### correct
+  ### correct
 
   ```ruby
   dnf_package 'nginx' do

diff --git a/docs-chef-io/assets/cookstyle/cops_chef_correctness_incorrectlibraryinjection.yml b/docs-chef-io/assets/cookstyle/cops_chef_correctness_incorrectlibraryinjection.yml
@@ -8,7 +8,7 @@ autocorrection: true
 target_chef_version: All Versions
 examples: |2-
 
-  #### incorrect
+  ### incorrect
 
   ```ruby
   ::Chef::Recipe.send(:include, Filebeat::Helpers)
@@ -17,7 +17,7 @@ examples: |2-
   ::Chef::Provider.include Filebeat::Helpers
   ```
 
-  #### correct
+  ### correct
 
   ```ruby
   ::Chef::DSL::Recipe.send(:include, Filebeat::Helpers) # covers previous Recipe & Provider classes

diff --git a/docs-chef-io/assets/cookstyle/cops_chef_correctness_invalidcookbookname.yml b/docs-chef-io/assets/cookstyle/cops_chef_correctness_invalidcookbookname.yml
@@ -7,13 +7,13 @@ autocorrection: false
 target_chef_version: All Versions
 examples: |2-
 
-  #### incorrect
+  ### incorrect
 
   ```ruby
   name 'foo.bar'
   ```
 
-  #### correct
+  ### correct
 
   ```ruby
   name 'foo_bar'

diff --git a/docs-chef-io/assets/cookstyle/cops_chef_correctness_invaliddefaultaction.yml b/docs-chef-io/assets/cookstyle/cops_chef_correctness_invaliddefaultaction.yml
@@ -7,13 +7,13 @@ autocorrection: false
 target_chef_version: All Versions
 examples: |2-
 
-  #### incorrect
+  ### incorrect
 
   ```ruby
   default_action 'create'
   ```
 
-  #### correct
+  ### correct
 
   ```ruby
   default_action :create

diff --git a/docs-chef-io/assets/cookstyle/cops_chef_correctness_invalidnotificationresource.yml b/docs-chef-io/assets/cookstyle/cops_chef_correctness_invalidnotificationresource.yml
@@ -8,7 +8,7 @@ autocorrection: false
 target_chef_version: All Versions
 examples: |2-
 
-  #### incorrect
+  ### incorrect
 
   ```ruby
 
@@ -21,7 +21,7 @@ examples: |2-
   end
   ```
 
-  #### correct
+  ### correct
 
   ```ruby
 

diff --git a/docs-chef-io/assets/cookstyle/cops_chef_correctness_invalidnotificationtiming.yml b/docs-chef-io/assets/cookstyle/cops_chef_correctness_invalidnotificationtiming.yml
@@ -8,7 +8,7 @@ autocorrection: false
 target_chef_version: All Versions
 examples: |2-
 
-  #### incorrect
+  ### incorrect
 
   ```ruby
 
@@ -17,7 +17,7 @@ examples: |2-
   end
   ```
 
-  #### correct
+  ### correct
 
   ```ruby
 

diff --git a/docs-chef-io/assets/cookstyle/cops_chef_correctness_invalidplatformfamilyhelper.yml b/docs-chef-io/assets/cookstyle/cops_chef_correctness_invalidplatformfamilyhelper.yml
@@ -9,13 +9,13 @@ autocorrection: true
 target_chef_version: All Versions
 examples: |2-
 
-  #### incorrect
+  ### incorrect
 
   ```ruby
   platform_family?('redhat')
   platform_family?('sles')
 
-  #### incorrect
+  ### incorrect
 
   ```ruby
   platform_family?('rhel')

diff --git a/docs-chef-io/assets/cookstyle/cops_chef_correctness_invalidplatformfamilyincase.yml b/docs-chef-io/assets/cookstyle/cops_chef_correctness_invalidplatformfamilyincase.yml
@@ -9,7 +9,7 @@ autocorrection: true
 target_chef_version: All Versions
 examples: |2-
 
-  #### incorrect
+  ### incorrect
 
   ```ruby
   case node['platform_family']

diff --git a/docs-chef-io/assets/cookstyle/cops_chef_correctness_invalidplatformhelper.yml b/docs-chef-io/assets/cookstyle/cops_chef_correctness_invalidplatformhelper.yml
@@ -9,15 +9,15 @@ autocorrection: false
 target_chef_version: All Versions
 examples: |2-
 
-  #### incorrect
+  ### incorrect
 
   ```ruby
   platform?('darwin')
   platform?('rhel')
   platform?('sles')
   ```
 
-  #### correct
+  ### correct
 
   ```ruby
   platform?('mac_os_x')

diff --git a/docs-chef-io/assets/cookstyle/cops_chef_correctness_invalidplatformincase.yml b/docs-chef-io/assets/cookstyle/cops_chef_correctness_invalidplatformincase.yml
@@ -8,7 +8,7 @@ autocorrection: true
 target_chef_version: All Versions
 examples: |2-
 
-  #### incorrect
+  ### incorrect
 
   ```ruby
   case node['platform']

diff --git a/docs-chef-io/assets/cookstyle/cops_chef_correctness_invalidplatformmetadata.yml b/docs-chef-io/assets/cookstyle/cops_chef_correctness_invalidplatformmetadata.yml
@@ -9,14 +9,14 @@ autocorrection: true
 target_chef_version: All Versions
 examples: |2-
 
-  #### incorrect
+  ### incorrect
 
   ```ruby
   supports 'darwin'
   supports 'mswin'
   ```
 
-  #### correct
+  ### correct
 
   ```ruby
   supports 'mac_os_x'

diff --git a/...io/assets/cookstyle/cops_chef_correctness_invalidplatformvalueforplatformfamilyhelper.yml b/...io/assets/cookstyle/cops_chef_correctness_invalidplatformvalueforplatformfamilyhelper.yml
@@ -9,7 +9,7 @@ autocorrection: false
 target_chef_version: All Versions
 examples: |2-
 
-  #### incorrect
+  ### incorrect
 
   ```ruby
   value_for_platform_family(
@@ -18,7 +18,7 @@ examples: |2-
   )
   ```
 
-  #### correct
+  ### correct
 
   ```ruby
   value_for_platform_family(

diff --git a/...-chef-io/assets/cookstyle/cops_chef_correctness_invalidplatformvalueforplatformhelper.yml b/...-chef-io/assets/cookstyle/cops_chef_correctness_invalidplatformvalueforplatformhelper.yml
@@ -9,15 +9,15 @@ autocorrection: false
 target_chef_version: All Versions
 examples: |2-
 
-  #### incorrect
+  ### incorrect
 
   ```ruby
   value_for_platform(
     %w(rhel mac_os_x_server) => { 'default' => 'foo' },
     %w(sles) => { 'default' => 'bar' }
   )```
 
-  #### correct
+  ### correct
 
   ```ruby
   value_for_platform(

diff --git a/docs-chef-io/assets/cookstyle/cops_chef_correctness_invalidversionmetadata.yml b/docs-chef-io/assets/cookstyle/cops_chef_correctness_invalidversionmetadata.yml
@@ -7,13 +7,13 @@ autocorrection: false
 target_chef_version: All Versions
 examples: |2-
 
-  #### incorrect
+  ### incorrect
 
   ```ruby
   version '1.2.3.4'
   ```
 
-  #### correct
+  ### correct
 
   ```ruby
   version '1.2.3'

diff --git a/docs-chef-io/assets/cookstyle/cops_chef_correctness_lazyevalnodeattributedefaults.yml b/docs-chef-io/assets/cookstyle/cops_chef_correctness_lazyevalnodeattributedefaults.yml
@@ -9,13 +9,13 @@ autocorrection: true
 target_chef_version: All Versions
 examples: |2-
 
-  #### incorrect
+  ### incorrect
 
   ```ruby
   property :Something, String, default: node['hostname']
   ```
 
-  #### correct
+  ### correct
 
   ```ruby
   property :Something, String, default: lazy { node['hostname'] }

diff --git a/docs-chef-io/assets/cookstyle/cops_chef_correctness_lazyinresourceguard.yml b/docs-chef-io/assets/cookstyle/cops_chef_correctness_lazyinresourceguard.yml
@@ -8,7 +8,7 @@ autocorrection: true
 target_chef_version: All Versions
 examples: |2-
 
-  #### incorrect
+  ### incorrect
 
   ```ruby
   template '/etc/foo' do
@@ -18,7 +18,7 @@ examples: |2-
   end
   ```
 
-  #### correct
+  ### correct
 
   ```ruby
   template '/etc/foo' do

diff --git a/docs-chef-io/assets/cookstyle/cops_chef_correctness_macosuserdefaultsinvalidtype.yml b/docs-chef-io/assets/cookstyle/cops_chef_correctness_macosuserdefaultsinvalidtype.yml
@@ -9,7 +9,7 @@ autocorrection: true
 target_chef_version: All Versions
 examples: |2-
 
-  #### incorrect
+  ### incorrect
 
   ```ruby
   macos_userdefaults 'set a value' do
@@ -19,7 +19,7 @@ examples: |2-
   end
   ```
 
-  #### correct
+  ### correct
 
   ```ruby
   macos_userdefaults 'set a value' do

diff --git a/...hef-io/assets/cookstyle/cops_chef_correctness_malformedplatformvalueforplatformhelper.yml b/...hef-io/assets/cookstyle/cops_chef_correctness_malformedplatformvalueforplatformhelper.yml
@@ -9,15 +9,15 @@ autocorrection: false
 target_chef_version: All Versions
 examples: |2-
 
-  #### incorrect
+  ### incorrect
 
   ```ruby
   value_for_platform(
     %w(redhat oracle) => 'baz'
   )
   ```
 
-  #### correct
+  ### correct
 
   ```ruby
   value_for_platform(

diff --git a/docs-chef-io/assets/cookstyle/cops_chef_correctness_metadatamalformeddepends.yml b/docs-chef-io/assets/cookstyle/cops_chef_correctness_metadatamalformeddepends.yml
@@ -8,14 +8,14 @@ autocorrection: true
 target_chef_version: All Versions
 examples: |2-
 
-  #### incorrect
+  ### incorrect
 
   ```ruby
   depends 'some_awesome_cookbook' '= 4.5.5'
   depends 'some_other_cool_cookbook' '< 8.0'
   ```
 
-  #### correct
+  ### correct
 
   ```ruby
   depends 'some_awesome_cookbook', '= 4.5.5'

diff --git a/docs-chef-io/assets/cookstyle/cops_chef_correctness_metadatamissingname.yml b/docs-chef-io/assets/cookstyle/cops_chef_correctness_metadatamissingname.yml
@@ -9,7 +9,7 @@ target_chef_version: All Versions
 examples: |-
   ```
 
-  #### correct
+  ### correct
 
   ```ruby
   name 'foo'

diff --git a/docs-chef-io/assets/cookstyle/cops_chef_correctness_metadatamissingversion.yml b/docs-chef-io/assets/cookstyle/cops_chef_correctness_metadatamissingversion.yml
@@ -8,7 +8,7 @@ target_chef_version: All Versions
 examples: |-
   ```
 
-  #### correct
+  ### correct
 
   ```ruby
   name 'foo'