Skip to content

Conversation

@joeafari
Copy link
Contributor

Documented the fact that only snapshots from the found-snapshots repository are allowed and the restore can't be made from a custom repository.

Documented the fact that only snapshots from the `found-snapshots` repository are allowed and the restore can't be made from a custom repository.
@joeafari joeafari requested a review from a team as a code owner October 31, 2025 19:48
@github-actions
Copy link

github-actions bot commented Oct 31, 2025

Copy link
Contributor

@yetanothertw yetanothertw left a comment

Choose a reason for hiding this comment

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

Thank you for fixing this!
I suggest adding an important admonition to add visibility and weight to your point.


1. First, [create a new deployment](../../deploy/cloud-enterprise/create-deployment.md) and select **Restore snapshot data**. Select the deployment that you want to restore a snapshot *from*. If you don’t know the exact name, you can enter a few characters and then select from the list of matching deployments.
2. Select the snapshot that you want to restore from. If none is chosen, the latest successful snapshot from the cluster you selected is restored on the new cluster when you create it.
*Please note that only snapshots from the `found-snapshots` repository are accepted. Snapshots from a custom repository are not allowed.*
Copy link
Contributor

@yetanothertw yetanothertw Nov 3, 2025

Choose a reason for hiding this comment

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

This addition seems important enough to warrant an admonition for emphasis. Perhaps something like this?

Suggested change
*Please note that only snapshots from the `found-snapshots` repository are accepted. Snapshots from a custom repository are not allowed.*
:::{important}
Note that only snapshots from the `found-snapshots` repository are accepted. Snapshots from a custom repository are not allowed.
:::

That's what it'd look like:
Image

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks for the addition, the important section gives it more visibility

Copy link
Contributor

Choose a reason for hiding this comment

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

Ok, I'll add the commit then if you don't mind.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks.

@yetanothertw yetanothertw merged commit 798c5aa into main Nov 3, 2025
7 checks passed
@yetanothertw yetanothertw deleted the joeafari-patch-2 branch November 3, 2025 17:16
@maggieghamry
Copy link
Contributor

Thanks so much for the reviews @yetanothertw! What's the best way to request a change to the naming? This page prefix is ece- but also applies to ech, can we consider resolving that as well?

@yetanothertw
Copy link
Contributor

Hi @maggieghamry ,

What's the best way to request a change to the naming? This page prefix is ece- but also applies to ech, can we consider resolving that as well?

Our source files use a tagging system to indicate which Elastic products and deployment models the content applies to. In the case of the Restore snapshot into a new deployment page, you can see that the page is tagged as applying both to ECE and ECH.

These badges are visual indicators on the published page, signalling to users that it applies to both these products:
image

You're right that ece is included in the name of the file -- I assume that's still present because renaming the file might result in a cascade of broken links and would require setting up additional redirects. Having said that, I think it's not entirely impossible to update it, so if you think it should be updated, would you please mind opening a new docs issue for this?

Many thanks! 🙏

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants