Skip to content

Commit

Permalink
docs: Pre-format example for named_stores_config (#14524)
Browse files Browse the repository at this point in the history
  • Loading branch information
paul1r authored Oct 17, 2024
1 parent 963a25b commit 71d1c6b
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 18 deletions.
28 changes: 16 additions & 12 deletions docs/sources/shared/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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: <named_stores_config>]
Expand Down
14 changes: 8 additions & 6 deletions tools/doc-generator/parse/root_blocks.go
Original file line number Diff line number Diff line change
Expand Up @@ -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.`,
},
{
Expand Down

0 comments on commit 71d1c6b

Please sign in to comment.