(Doc+) Expand watermark resolution #116892

stefnestor · 2024-11-16T20:25:50Z

👋 howdy, team! Related to https://github.com/elastic/cloud/pull/134247, expands the resolution section to better enable users to self-service on ESS & avoid rather than thinking they need to contact Support per @kunisen 's feedback (cheers!)

@kunisen

👋 howdy, team! Related to elastic/cloud#134247, expands the resolution section to better enable users to self-service on ESS & avoid rather than thinking they need to contact Support per @kunisen 's feedback (cheers!)

github-actions · 2024-11-16T20:25:59Z

Documentation preview:

✨ Changed pages

elasticsearchmachine · 2024-11-16T20:26:12Z

@stefnestor please enable the option "Allow edits and access to secrets by maintainers" on your PR. For more information, see the documentation.

elasticsearchmachine · 2024-11-16T20:26:13Z

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

kunisen · 2024-11-18T14:12:22Z

Hi Stef, thanks for your great doc contribution as always!
I made some updates based on our conversation here

[1]

After merge, it looks like below:

:: ESS

:: Self Managed

[2]

Main difference between your proposal and this one:

I made a tab to switch between ESS and self-managed
For ESS, I added all the tips and notes, that users need to care
For Self managed, I left as is with your original wording with some slight tweaks (remove the ESS parts, use big letter in bullet-in items to keep them align with ESS side, since ESS side is originally referred from this doc - 1 and this doc - 2)
I also changed ESS side to make it simpler, point to How can I customize the components of my deployment? page directly, without attaching other extra screenshots, etc)

[3]

I think we can remove or merge the ESS side doc to point to ES side, once this ES side PR is merged. As we chatted earlier :)

That said, hope this makes sense to you and happy to revert my change or update based on your further suggestion.
Also, please feel free to make updates directly too. My one is more for idea proposal - like we chatted over slack, I wanted to share wha's in my mind into a detailed way in above screenshots.

Thanks!

…-managed

kunisen · 2024-11-18T14:13:44Z

run docs-build

kunisen · 2024-11-18T14:14:50Z

hmm it doesn't seem to work and give me a preview as mentioned in https://github.com/elastic/elasticsearch/tree/main/docs#build-the-docs...

shainaraskas · 2024-11-18T15:14:11Z

@kunisen looks like the preview is refreshed now

stefnestor · 2024-11-19T16:20:34Z

docs/reference/tab-widgets/troubleshooting/watermark/troubleshooting-watermark.asciidoc

+
+Also, for future prevention, you can do below:
+
+* {cloud}/ec-customize-deployment-components.html[Increase the disk size on your Hot data and Content tier (scale up)]


It's invalid to restrict this to only hot/content tier, it can happen on any data tier, here and above

stefnestor · 2024-11-19T16:25:22Z

@kunisen, cheers!

My version makes more sense to me, but we are direct ballpark of each other so it doesn't matter to me 💚.

I left a caveat on a statement that was too isolated & also wanted to note that you accidentally segmented immediate resolution (delete unneeded, scale disk/nodes) from the self-managed where it's also valid (not just for ESS/ECE).

kunisen · 2024-12-16T08:56:46Z

Thanks Stef for being patient. 🙏

:: [1]

Sorry I am a bit confused. Maybe I didn't explain this clear enough and I hope you don't mind me rephrasing my words 🙏

My version makes more sense to me, but we are direct ballpark of each other so it doesn't matter to me 💚.
I left a caveat on a statement that was too isolated & also wanted to note that you accidentally segmented immediate resolution (delete unneeded, scale disk/nodes) from the self-managed where it's also valid (not just for ESS/ECE).

The biggest difference between yours and mind is the order.

In ECH (fka ESS), customer can't scale up if disk is full. So the only choice is to delete unused data. And that's why I put "Delete unused data." in the first.
In your doc, it's listed as the 3rd item.

So that's why I thought we have to separate it into 2 tab sections - one for ECH, and one for self-managed.
Also you can see in the self-managed tab section, the 2 actions are actually there too, but the order is different (your original description).

=> That said, I think we are on the same page about call to actions. If you agree with the order above I mentioned, then we can have your version as is, since that's way much simpler which is preferred.

:: [2]

It's invalid to restrict this to only hot/content tier, it can happen on any data tier, here and above

Great point. Will update to reflect after having your thoughts above [1].

Thanks again! 🙏

stefnestor · 2024-12-18T20:49:49Z

docs/reference/tab-widgets/troubleshooting/watermark/troubleshooting-watermark.asciidoc

@@ -0,0 +1,25 @@
+// tag::cloud[]
+
+* {ref}/docs-delete.html[Delete unused data].


We usually recommend deleting per index not doc otherwise you don't quickly clean out disk.

Ah thanks @stefnestor WDYT we use this one?
https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-delete-index.html

Yep, that's the one I linked below 🙂

stefnestor · 2024-12-18T20:51:22Z

Yeah, again I don't feel strongly on the formatting 🙂. I added a second comment about technical implementation but otherwise LGTM to pull out of draft for Docs+Dev. 🙏

kunisen · 2024-12-19T08:42:19Z

Thank you @stefnestor! Eagle eyes!

Once you confirmed the above is good, I will make the commit.
One more thing want to check with you: Could I revert this PR to Ready for review so that we can be ready for doc team's review and then merge?

Thanks!

Relaunch #116892 since the original one seems to be outdated and hard to update branch.

* (Doc+) Expand watermark resolution Relaunch #116892 since the original one seems to be outdated and hard to update branch. * Apply suggestions from code review Co-authored-by: shainaraskas <[email protected]> --------- Co-authored-by: shainaraskas <[email protected]>

* (Doc+) Expand watermark resolution Relaunch #116892 since the original one seems to be outdated and hard to update branch. * Apply suggestions from code review Co-authored-by: shainaraskas <[email protected]> --------- Co-authored-by: shainaraskas <[email protected]> (cherry picked from commit a0f1856) Co-authored-by: Kuni Sen <[email protected]>

(Doc+) Expand watermark resolution

10fb2b1

👋 howdy, team! Related to elastic/cloud#134247, expands the resolution section to better enable users to self-service on ESS & avoid rather than thinking they need to contact Support per @kunisen 's feedback (cheers!)

stefnestor added >enhancement >docs General docs changes Team:Docs Meta label for docs team labels Nov 16, 2024

stefnestor requested a review from a team November 16, 2024 20:25

elasticsearchmachine added external-contributor Pull request authored by a developer outside the Elasticsearch team v9.0.0 labels Nov 16, 2024

Added some change to make it more recognize-able between ESS and self…

2eea980

…-managed

stefnestor marked this pull request as draft November 18, 2024 21:10

stefnestor commented Nov 19, 2024

View reviewed changes

Merge branch 'main' into stefnestor-patch-1

91f6d14

stefnestor commented Dec 18, 2024

View reviewed changes

kunisen added a commit that referenced this pull request Dec 20, 2024

(Doc+) Expand watermark resolution

6209be2

Relaunch #116892 since the original one seems to be outdated and hard to update branch.

kunisen mentioned this pull request Dec 20, 2024

(Doc+) Expand watermark resolution #119174

Merged

stefnestor closed this Dec 20, 2024


		Also, for future prevention, you can do below:

		* {cloud}/ec-customize-deployment-components.html[Increase the disk size on your Hot data and Content tier (scale up)]

		@@ -0,0 +1,25 @@
		// tag::cloud[]

		* {ref}/docs-delete.html[Delete unused data].

(Doc+) Expand watermark resolution #116892

(Doc+) Expand watermark resolution #116892

Uh oh!

Conversation

stefnestor commented Nov 16, 2024

Uh oh!

github-actions bot commented Nov 16, 2024

Uh oh!

elasticsearchmachine commented Nov 16, 2024

Uh oh!

elasticsearchmachine commented Nov 16, 2024

Uh oh!

kunisen commented Nov 18, 2024

[1]

[2]

[3]

Uh oh!

kunisen commented Nov 18, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

kunisen commented Nov 18, 2024

Uh oh!

shainaraskas commented Nov 18, 2024

Uh oh!

stefnestor Nov 19, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

stefnestor commented Nov 19, 2024

Uh oh!

kunisen commented Dec 16, 2024

:: [1]

:: [2]

Uh oh!

stefnestor Dec 18, 2024

Choose a reason for hiding this comment

Uh oh!

kunisen Dec 19, 2024

Choose a reason for hiding this comment

Uh oh!

stefnestor Dec 19, 2024

Choose a reason for hiding this comment

Uh oh!

stefnestor commented Dec 18, 2024

Uh oh!

kunisen commented Dec 19, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

kunisen commented Nov 18, 2024 •

edited

Loading

stefnestor Nov 19, 2024 •

edited

Loading