Skip to content

Clarify snapshot docs #1782

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

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

Clarify snapshot docs #1782

wants to merge 5 commits into from

Conversation

kunisen
Copy link
Contributor

@kunisen kunisen commented Jun 18, 2025

Description

Add some screenshots to make the instructions more easily to be followed by users.
(This is the 2nd try of #1781)

Notes

This is a part of the tasks stemmed from an internal ticket: https://github.com/elastic/support-tech-lead/issues/1596
@eedugon @shainaraskas @jakommo for anything that's unclear, let's discuss this in the internal ticket.

Preview

deploy-manage/tools/snapshot-and-restore/create-snapshots.md

@kunisen kunisen requested a review from eedugon June 18, 2025 10:52
@kunisen kunisen self-assigned this Jun 18, 2025
@kunisen kunisen requested a review from a team as a code owner June 18, 2025 10:52
@kunisen kunisen added documentation Improvements or additions to documentation supportability ability enable self-service or support of product Team:Platform Issues owned by the Platform Docs Team labels Jun 18, 2025
Copy link

github-actions bot commented Jun 18, 2025

🔍 Preview links for changed docs:

🔔 The preview site may take up to 3 minutes to finish building. These links will become live once it completes.

Copy link
Contributor

@eedugon eedugon left a comment

Choose a reason for hiding this comment

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

This LGTM!
I'm ok with adding these screenshots and give better visibility of how snapshots are handled within Kibana, but I'd like @shainaraskas to share her thoughts too before merging.

Copy link
Collaborator

@shainaraskas shainaraskas left a comment

Choose a reason for hiding this comment

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

I'll approve this so i'm not blocking, but I think the first two screenshots should ideally be removed. Ultimately, they often just cause confusion when they fall out of date.

provided a couple of small copyedits

@kunisen
Copy link
Contributor Author

kunisen commented Jun 21, 2025

I'll approve this so i'm not blocking, but I think the first two screenshots should ideally be removed. Ultimately, they often just cause confusion when they fall out of date.

Thanks. I share your concern.

Also as I chatted with @eedugon, I totally get that, it might be

  • hard to maintain (rendering could change anytime),
  • hard to update (you don't want to spin up a test box and just for new screenshot capturing),
  • hard to refer (texts are only in screenshot pics and can't copy out or be searchable).
     
    but it's the easiest way for users to follow I have to say, they can know what they need to do in 1 sec.
    => Also you got the motivation from internal tickets that why we needed to do so.
     
    Another logical rationale to put screenshots there was because UI didn't change in 8.x and 9.x, (left menu navigation bar changed, but the snapshot UI almost didn't change).
    So it seems to me that this screenshot will probably live for another major version for years.
    (And later, when we got feedback from folks that the screenshot is outdated, we can revisit this and remove it then)

I read the pros is >> cons, which is the whole point of adding this when we discussed.


provided a couple of small copyedits

Thanks! Responded and resolved the comments.


cc @jakommo

@kunisen kunisen enabled auto-merge (squash) June 21, 2025 03:13
@eedugon
Copy link
Contributor

eedugon commented Jun 21, 2025 via email

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation supportability ability enable self-service or support of product Team:Platform Issues owned by the Platform Docs Team
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants