Use inline code blocks for partial names in documentation

This also brings the documentation into line with the existing markdown used in install_package.md This avoids CI from failing due to markdownlint warnings. Signed-off-by: Andy Allan <[email protected]>
sous-chefs · Oct 27, 2023 · fb0eba0 · fb0eba0
1 parent d53be87
commit fb0eba0
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 2 deletions.
diff --git a/documentation/install.md b/documentation/install.md
@@ -1,6 +1,8 @@
 # `elasticsearch_install`
 
-The install_repository.rb class is part of the Elasticsearch Cookbook and is responsible for managing the installation and removal of Elasticsearch repositories. It includes helper methods from the ElasticsearchCookbook::Helpers module and utilizes partials _common.rb and_repository.rb for defining properties related to Elasticsearch instances and repository options.
+The install_repository.rb class is part of the Elasticsearch Cookbook and is responsible for managing the installation and removal of Elasticsearch repositories.
+
+It includes helper methods from the `ElasticsearchCookbook::Helpers` module and utilizes partials `_common.rb` and `_repository.rb` for defining properties related to Elasticsearch instances and repository options.
 
 ## Properties
 

diff --git a/documentation/install_repository.md b/documentation/install_repository.md
@@ -1,6 +1,8 @@
 # install_repository
 
-The install_repository.rb class is part of the Elasticsearch Cookbook and is responsible for managing the installation and removal of Elasticsearch repositories. It includes helper methods from the ElasticsearchCookbook::Helpers module and utilizes partials _common.rb and_repository.rb for defining properties related to Elasticsearch instances and repository options.
+The install_repository.rb class is part of the Elasticsearch Cookbook and is responsible for managing the installation and removal of Elasticsearch repositories.
+
+It includes helper methods from the `ElasticsearchCookbook::Helpers` module and utilizes partials `_common.rb` and `_repository.rb` for defining properties related to Elasticsearch instances and repository options.
 
 ## Notes