summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTim Smith <tsmith84@gmail.com>2021-08-13 17:33:28 -0700
committerTim Smith <tsmith84@gmail.com>2021-08-13 17:33:28 -0700
commit75385528acc7969205fd185e11481bf61b121499 (patch)
tree2344530c42132adebba0802acd6aba876a639063
parent14fe44cdc5a913c4d5f206f6921a0ebac8578fbd (diff)
downloadchef-75385528acc7969205fd185e11481bf61b121499.tar.gz
Format examples better
Signed-off-by: Tim Smith <tsmith@chef.io>
-rw-r--r--lib/chef/resource/ruby_block.rb12
1 files changed, 6 insertions, 6 deletions
diff --git a/lib/chef/resource/ruby_block.rb b/lib/chef/resource/ruby_block.rb
index 6df1eeedcb..b0ab19002f 100644
--- a/lib/chef/resource/ruby_block.rb
+++ b/lib/chef/resource/ruby_block.rb
@@ -30,7 +30,7 @@ class Chef
description "Use the **ruby_block** resource to execute Ruby code during a #{ChefUtils::Dist::Infra::PRODUCT} run. Ruby code in the `ruby_block` resource is evaluated with other resources during convergence, whereas Ruby code outside of a `ruby_block` resource is evaluated before other resources, as the recipe is compiled."
examples <<~'DOC'
- Re-read configuration data
+ **Reload Chef Infra Client configuration data**
```ruby
ruby_block 'reload_client_config' do
@@ -41,7 +41,7 @@ class Chef
end
```
- Run a block on a particular platform
+ **Run a block on a particular platform**
The following example shows how an if statement can be used with the `windows?` method in the Chef Infra Language to run code specific to Microsoft Windows. The code is defined using the ruby_block resource:
@@ -58,7 +58,7 @@ class Chef
end
```
- Stash a file in a data bag
+ **Stash a file in a data bag**
The following example shows how to use the ruby_block resource to stash a BitTorrent file in a data bag so that it can be distributed to nodes in the organization.
@@ -83,7 +83,7 @@ class Chef
end
```
- Update the /etc/hosts file
+ **Update the /etc/hosts file**
The following example shows how the ruby_block resource can be used to update the /etc/hosts file:
@@ -98,7 +98,7 @@ class Chef
end
```
- Set environment variables
+ **Set environment variables**
The following example shows how to use variables within a Ruby block to set environment variables using rbenv.
@@ -114,7 +114,7 @@ class Chef
end
```
- Call methods in a gem
+ **Call methods in a gem**
The following example shows how to call methods in gems not shipped in Chef Infra Client