From 71d1c6bcd40e2bb5b3d2e23fb03f4427f704f86b Mon Sep 17 00:00:00 2001 From: Paul Rogers <129207811+paul1r@users.noreply.github.com> Date: Thu, 17 Oct 2024 17:01:45 -0400 Subject: [PATCH] docs: Pre-format example for named_stores_config (#14524) --- docs/sources/shared/configuration.md | 28 ++++++++++++++---------- tools/doc-generator/parse/root_blocks.go | 14 +++++++----- 2 files changed, 24 insertions(+), 18 deletions(-) diff --git a/docs/sources/shared/configuration.md b/docs/sources/shared/configuration.md index 0747b47667ef2..28145ea6059e5 100644 --- a/docs/sources/shared/configuration.md +++ b/docs/sources/shared/configuration.md @@ -4064,12 +4064,14 @@ When a memberlist config with atleast 1 join_members is defined, kvstore of type Configures additional object stores for a given storage provider. Supported stores: aws, azure, bos, filesystem, gcs, swift. Example: -storage_config: - named_stores: - aws: - store-1: - endpoint: s3://foo-bucket - region: us-west1 +```yaml + storage_config: + named_stores: + aws: + store-1: + endpoint: s3://foo-bucket + region: us-west1 +``` Named store from this example can be used by setting object_store to store-1 in period_config. ```yaml @@ -5555,12 +5557,14 @@ hedging: # Configures additional object stores for a given storage provider. # Supported stores: aws, azure, bos, filesystem, gcs, swift. # Example: -# storage_config: -# named_stores: -# aws: -# store-1: -# endpoint: s3://foo-bucket -# region: us-west1 +# ```yaml +# storage_config: +# named_stores: +# aws: +# store-1: +# endpoint: s3://foo-bucket +# region: us-west1 +# ``` # Named store from this example can be used by setting object_store to store-1 # in period_config. [named_stores: ] diff --git a/tools/doc-generator/parse/root_blocks.go b/tools/doc-generator/parse/root_blocks.go index 1bfcc57bc8965..43e8f800dbbaf 100644 --- a/tools/doc-generator/parse/root_blocks.go +++ b/tools/doc-generator/parse/root_blocks.go @@ -280,12 +280,14 @@ When a memberlist config with atleast 1 join_members is defined, kvstore of type Desc: `Configures additional object stores for a given storage provider. Supported stores: aws, azure, bos, filesystem, gcs, swift. Example: -storage_config: - named_stores: - aws: - store-1: - endpoint: s3://foo-bucket - region: us-west1 +` + "```yaml" + ` + storage_config: + named_stores: + aws: + store-1: + endpoint: s3://foo-bucket + region: us-west1 +` + "```" + ` Named store from this example can be used by setting object_store to store-1 in period_config.`, }, {