Move snapshot/restore reference content to reference - part II#5544
Draft
yetanothertw wants to merge 1 commit intomainfrom
Draft
Move snapshot/restore reference content to reference - part II#5544yetanothertw wants to merge 1 commit intomainfrom
yetanothertw wants to merge 1 commit intomainfrom
Conversation
Contributor
Vale Linting ResultsSummary: 3 warnings, 9 suggestions found
|
| File | Line | Rule | Message |
|---|---|---|---|
| deploy-manage/tools/snapshot-and-restore/s3-repository.md | 222 | Elastic.Latinisms | Latin terms and abbreviations are a common source of confusion. Use 'for example' instead of 'e.g'. |
| deploy-manage/tools/snapshot-and-restore/s3-repository.md | 224 | Elastic.Latinisms | Latin terms and abbreviations are a common source of confusion. Use 'using' instead of 'via'. |
| deploy-manage/tools/snapshot-and-restore/s3-repository.md | 240 | Elastic.DontUse | Don't use 'very'. |
💡 Suggestions (9)
| File | Line | Rule | Message |
|---|---|---|---|
| deploy-manage/tools/snapshot-and-restore/azure-repository.md | 106 | Elastic.WordChoice | Consider using 'can, might' instead of 'may', unless the term is in the UI. |
| deploy-manage/tools/snapshot-and-restore/azure-repository.md | 140 | Elastic.WordChoice | Consider using 'can, might' instead of 'may', unless the term is in the UI. |
| deploy-manage/tools/snapshot-and-restore/google-cloud-storage-repository.md | 97 | Elastic.Wordiness | Consider using 'use' instead of 'utilize'. |
| deploy-manage/tools/snapshot-and-restore/s3-repository.md | 79 | Elastic.WordChoice | Consider using 'can, might' instead of 'may', unless the term is in the UI. |
| deploy-manage/tools/snapshot-and-restore/s3-repository.md | 79 | Elastic.WordChoice | Consider using 'can, might' instead of 'may', unless the term is in the UI. |
| deploy-manage/tools/snapshot-and-restore/s3-repository.md | 222 | Elastic.WordChoice | Consider using 'can, might' instead of 'may', unless the term is in the UI. |
| deploy-manage/tools/snapshot-and-restore/s3-repository.md | 222 | Elastic.Wordiness | Consider using 'remove' instead of 'eliminate'. |
| deploy-manage/tools/snapshot-and-restore/s3-repository.md | 236 | Elastic.WordChoice | Consider using 'can, might' instead of 'may', unless the term is in the UI. |
| deploy-manage/tools/snapshot-and-restore/s3-repository.md | 236 | Elastic.WordChoice | Consider using 'can, might' instead of 'may', unless the term is in the UI. |
The Vale linter checks documentation changes against the Elastic Docs style guide.
To use Vale locally or report issues, refer to Elastic style guide for Vale.
This was referenced Mar 19, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Part of #1465
Summary
The S3, Azure, and GCS repository pages in docs-content mix how-to/setup content with dense reference tables of client and repository settings. This makes the pages harder to navigate and users looking up a specific setting have to scroll through setup instructions, while users following a setup guide have to wade through long settings lists. Extracting the settings into dedicated reference pages in the elasticsearch repo separates concerns and establishes a home for repository settings reference alongside the existing cluster-level snapshot settings.
The PR to extract the reference information elastic/elasticsearch#144481 must be merged first, so that the links in this doc can resolve successfully.
Generative AI disclosure