From fb0eba0d4e191a3960ecde94b909970cbb5f573c Mon Sep 17 00:00:00 2001 From: Andy Allan Date: Fri, 27 Oct 2023 11:10:30 +0100 Subject: [PATCH] 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 --- documentation/install.md | 4 +++- documentation/install_repository.md | 4 +++- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/documentation/install.md b/documentation/install.md index 330bd5fe2..af5caba08 100644 --- 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 index fd7285001..e362effb5 100644 --- 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