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

Slightly adjust docs about S3 incompatibilities #99624

Conversation

DaveCTurner
Copy link
Contributor

It's often useful to quote these docs to users encountering problems
with their not-quite-S3-compatible storage system. In practice we don't
need to quote the bits in the middle but we do need the last sentence
about working with the supplier to address incompatibilities. This
commit reorders things so that the most commonly quoted sentences form a
standalone paragraph.

It's often useful to quote these docs to users encountering problems
with their not-quite-S3-compatible storage system. In practice we don't
need to quote the bits in the middle but we do need the last sentence
about working with the supplier to address incompatibilities. This
commit reorders things so that the most commonly quoted sentences form a
standalone paragraph.
@DaveCTurner DaveCTurner added >docs General docs changes :Distributed/Snapshot/Restore Anything directly related to the `_snapshot/*` APIs Supportability Improve our (devs, SREs, support eng, users) ability to troubleshoot/self-service product better. v8.11.0 v8.10.1 v8.9.3 labels Sep 18, 2023
@github-actions
Copy link
Contributor

Documentation preview:

@elasticsearchmachine elasticsearchmachine added Team:Distributed Meta label for distributed team Team:Docs Meta label for docs team labels Sep 18, 2023
@elasticsearchmachine
Copy link
Collaborator

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

@elasticsearchmachine
Copy link
Collaborator

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

Copy link
Contributor

@jrodewig jrodewig left a comment

Choose a reason for hiding this comment

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

LGTM. Left a minor suggestion you can take or leave as wanted. Thanks!

docs/reference/snapshot-restore/repository-s3.asciidoc Outdated Show resolved Hide resolved
@DaveCTurner DaveCTurner added auto-merge-without-approval Automatically merge pull request when CI checks pass (NB doesn't wait for reviews!) auto-backport-and-merge labels Sep 18, 2023
@DaveCTurner
Copy link
Contributor Author

Thanks James, I took your shorter sentences and rejigged them a little more in d8957cd.

Copy link
Contributor

@jrodewig jrodewig left a comment

Choose a reason for hiding this comment

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

Changes look great! Thanks @DaveCTurner!

@elasticsearchmachine elasticsearchmachine merged commit 3691312 into elastic:main Sep 18, 2023
4 checks passed
@DaveCTurner DaveCTurner deleted the 2023/09/18/s3-incompatibilities-docs-tweak branch September 18, 2023 12:26
DaveCTurner added a commit to DaveCTurner/elasticsearch that referenced this pull request Sep 18, 2023
It's often useful to quote these docs to users encountering problems
with their not-quite-S3-compatible storage system. In practice we don't
need to quote the bits in the middle but we do need the last sentence
about working with the supplier to address incompatibilities. This
commit reorders things so that the most commonly quoted sentences form a
standalone paragraph.
DaveCTurner added a commit to DaveCTurner/elasticsearch that referenced this pull request Sep 18, 2023
It's often useful to quote these docs to users encountering problems
with their not-quite-S3-compatible storage system. In practice we don't
need to quote the bits in the middle but we do need the last sentence
about working with the supplier to address incompatibilities. This
commit reorders things so that the most commonly quoted sentences form a
standalone paragraph.
@elasticsearchmachine
Copy link
Collaborator

💚 Backport successful

Status Branch Result
8.10
8.9

elasticsearchmachine pushed a commit that referenced this pull request Sep 18, 2023
It's often useful to quote these docs to users encountering problems
with their not-quite-S3-compatible storage system. In practice we don't
need to quote the bits in the middle but we do need the last sentence
about working with the supplier to address incompatibilities. This
commit reorders things so that the most commonly quoted sentences form a
standalone paragraph.
elasticsearchmachine pushed a commit that referenced this pull request Sep 18, 2023
It's often useful to quote these docs to users encountering problems
with their not-quite-S3-compatible storage system. In practice we don't
need to quote the bits in the middle but we do need the last sentence
about working with the supplier to address incompatibilities. This
commit reorders things so that the most commonly quoted sentences form a
standalone paragraph.
@DaveCTurner DaveCTurner restored the 2023/09/18/s3-incompatibilities-docs-tweak branch June 17, 2024 06:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
auto-merge-without-approval Automatically merge pull request when CI checks pass (NB doesn't wait for reviews!) :Distributed/Snapshot/Restore Anything directly related to the `_snapshot/*` APIs >docs General docs changes Supportability Improve our (devs, SREs, support eng, users) ability to troubleshoot/self-service product better. Team:Distributed Meta label for distributed team Team:Docs Meta label for docs team v8.9.3 v8.10.1 v8.11.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants