-
Notifications
You must be signed in to change notification settings - Fork 104
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
base: main
Are you sure you want to change the base?
Clarify snapshot docs #1782
Conversation
🔍 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. |
Co-authored-by: Edu González de la Herrán <[email protected]>
There was a problem hiding this 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.
There was a problem hiding this 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
Co-authored-by: shainaraskas <[email protected]>
Co-authored-by: shainaraskas <[email protected]>
Co-authored-by: shainaraskas <[email protected]>
Thanks. I share your concern. Also as I chatted with @eedugon, I totally get that, it might be
I read the pros is >> cons, which is the whole point of adding this when we discussed.
Thanks! Responded and resolved the comments. cc @jakommo |
my 2 cents on the conversation:
- The fact that “handling snapshots with Kibana” is / was almost
undocumented is a known issue, and I agree with Kuni it’s important to
improve because users prefer to manage things with the UI in general.
- I agree good and accurate text would be better than simply screenshots,
and in some areas we have already evolved in that way.
- My proposal is to keep these screenshots now (for efficiency reasons),
and in a future iteration we can fully document all the options properly
and reduce the amount of screenshots (or removing them all).
I was going to propose to remove 2 screenshots in the PR, but then I
realized that some of the options highlighted in the screenshot are not
documented (maybe in the API docs?), so I thought the screenshot was worthy
until at least we improve the narrative.
Cheers!!
Edu González de la Herrán
Senior Technical Writer @ Elastic
*Please note: Emails may be stored and shared to provide a better customer
experience. To learn more about how we use your information, please review
Elastic’s **Privacy Statement. *
<https://www.elastic.co/legal/privacy-statement>
El El sáb, 21 jun 2025 a las 5:13, Kuni Sen ***@***.***>
escribió:
… *kunisen* left a comment (elastic/docs-content#1782)
<#1782 (comment)>
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 <https://github.com/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 <https://github.com/jakommo>
—
Reply to this email directly, view it on GitHub
<#1782 (comment)>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/AGBFXJMNNCFR2DUERBHRSED3ETEVHAVCNFSM6AAAAAB7SXUOECVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDSOJTGI4DEMRXHE>
.
You are receiving this because you were mentioned.Message ID:
***@***.***>
|
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