Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOCS] clarify that the repo location setting accepts only one value #108267

Merged
merged 1 commit into from
May 6, 2024

Conversation

shainaraskas
Copy link
Contributor

Fixes #97339

Clarifies that location should be a single value.

To reviewers: given that multiple values aren't explicitly rejected, is accepts ok wording?

To avoid making this issue bigger than it should be, I chose to present the "single value" requirement in contrast to the path.repo setting it references. hopefully this will make it so that we don't have to clarify the entire bug in the docs.

@shainaraskas shainaraskas added >docs General docs changes :Distributed Coordination/Snapshot/Restore Anything directly related to the `_snapshot/*` APIs Team:Docs Meta label for docs team auto-backport-and-merge v8.14.0 v8.13.3 v8.13.4 labels May 3, 2024
Copy link
Contributor

github-actions bot commented May 3, 2024

Documentation preview:

@elasticsearchmachine elasticsearchmachine added Team:Distributed (Obsolete) Meta label for distributed team (obsolete). Replaced by Distributed Indexing/Coordination. v8.15.0 labels May 3, 2024
@elasticsearchmachine
Copy link
Collaborator

Pinging @elastic/es-docs (Team:Docs)

@elasticsearchmachine
Copy link
Collaborator

Pinging @elastic/es-distributed (Team:Distributed)

@shainaraskas shainaraskas requested review from a team May 3, 2024 19:56
Copy link
Contributor

@karenzone karenzone left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Like the way you handled this. LGTM pending clean docs-ci

@@ -33,7 +33,8 @@ in snapshots. Data files are not compressed. Defaults to `true`.
(Required, string)
Location of the shared filesystem used to store and retrieve snapshots. This
location must be registered in the `path.repo` setting on all master and data
nodes in the cluster.
nodes in the cluster.
Unlike `path.repo`, this setting supports only a single file path.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I love it when people put the "only" in the right place. :-) This is awesome.

@shainaraskas shainaraskas merged commit b84bd45 into elastic:main May 6, 2024
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
:Distributed Coordination/Snapshot/Restore Anything directly related to the `_snapshot/*` APIs >docs General docs changes Team:Distributed (Obsolete) Meta label for distributed team (obsolete). Replaced by Distributed Indexing/Coordination. Team:Docs Meta label for docs team v8.13.3 v8.13.4 v8.14.0 v8.15.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Docs] Clarify Shared file system repository location setting
4 participants