Skip to content

ECH: Move nodes off allocator doc updated #1619

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 22 commits into
base: main
Choose a base branch
from

Conversation

eedugon
Copy link
Contributor

@eedugon eedugon commented Jun 5, 2025

As described in #1527, this PR is promoting a knowledge article into our existing doc, per @kunisen and support team request.

Preview:

Changes:

  • Title updated
  • Email notifications section fixed (it wasn't valid).
  • Content of mentioned KB integrated into the doc.

Links to existing KB:

Closes #1527

@eedugon eedugon marked this pull request as ready for review June 5, 2025 10:09
@eedugon eedugon requested review from a team as code owners June 5, 2025 10:09
@kunisen

This comment was marked as outdated.

@eedugon
Copy link
Contributor Author

eedugon commented Jun 5, 2025

@kunisen , about the comment you have shared:

But one thing I just noticed, is maybe we could add a "Frequently Asked Questions (FAQs)" sub heading in the page so that readers can understand we included a bunch of FAQs.

The headings are in "Q&A" format style already, but that's something I wasn't sure if it was the right approach, and I wanted to double check that with other docs folks.

I agree if the headings are kept in this Q&A format, then a "Frequently Asked Questions" heading would make all sense, but maybe we rewrite the headers to be in a different format.

cc: @shainaraskas , what would you say?

Copy link
Contributor

@jakommo jakommo left a comment

Choose a reason for hiding this comment

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

Left a few small comments, but other than that LGTM!

@shainaraskas
Copy link
Collaborator

shainaraskas commented Jun 5, 2025

The headings are in "Q&A" format style already, but that's something I wasn't sure if it was the right approach, and I wanted to double check that with other docs folks.

I agree if the headings are kept in this Q&A format, then a "Frequently Asked Questions" heading would make all sense, but maybe we rewrite the headers to be in a different format.

this isn't really in our style (reasoning) and could be reworked

a couple of them should be removed (e.g. the support CTA), or integrated into the doc ("Could such a system maintenance be avoided or skipped?" should just be introductory information about why this happens and its inevitability)

some could be pulled into an "Availability during system maintenance" section and perhaps "Data loss risk for non-HA deployments"

some of them could be reworded ("How can I be notified when a node is changed?" > "Notifications for moved or changed nodes" [more task-based]).

I do think that if we want to keep these together, they do need a heading of their own so they're not nested below "Possible causes and impact"

@eedugon
Copy link
Contributor Author

eedugon commented Jun 5, 2025

@shainaraskas : I'll do some rework on this to avoid the FAQ style while keeping all the key points we want to communicate to the users. Thanks a lot for your feedback!

@kunisen
Copy link
Contributor

kunisen commented Jun 6, 2025

Thanks for being patient and all the help! 🙏

[1]

I made a bunch of updates based on internal ticket comments - https://github.com/elastic/support-tech-lead/issues/1576#issuecomment-2948156720.

Here's the preview:
https://docs-v3-preview.elastic.dev/elastic/docs-content/pull/1619/troubleshoot/monitoring/node-moves-outages

[2]

@eedugon I totally get what you and @shainaraskas said above #1619 (comment). Please feel free to make any updates from docs perspective based on your writing standard.

I still added FAQ heading because if we don't have this, it's logically unbalanced and not ready for being merged.
I know it's not clearing the docs criteria, but in case it takes long or great effort to reorganize the wordings, it's technically and logically ready for merge, which means we could do the merge first, and then think about the wording improvement next.

Again, please feel free to make your change even including the removal of that one.

[3]

Also, I believe it's technically clear now so no longer need to discuss anything further internally. But if still anything is technically unclear or regarding the expectation, let's still discuss it internally ha :)

@eedugon
Copy link
Contributor Author

eedugon commented Jun 10, 2025

@kunisen , very good suggestion, next time feel free to add them directly in the code (as suggestions) and we can discuss them there.

I've applied the changes, thanks a lot!

@kunisen
Copy link
Contributor

kunisen commented Jun 11, 2025

Thanks @eedugon indeed I will use suggest next time. 🙏

@shainaraskas could you kindly help us double check if we are good to go please?
Once we merge the public doc PR, I will tweak a little of our KB to make it more adaptive to public doc.

Then I think we should be good to go :)

Copy link

github-actions bot commented Jun 12, 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.

@kunisen
Copy link
Contributor

kunisen commented Jun 19, 2025

Hi @shainaraskas

Thank you so much for all the detailed suggestions. Very clear and helpful!

Based on your suggestion, I almost rewrote the whole page in a more logical way.
I started to understand your point of not using Q&A, as well as how to make them in a declarative way.
I am still a beginner on this so my change might include confusing parts (and if so please kindly help me make edits), but I think the whole passage now makes more logical sense.

That said, may I trouble you to review it again and see if we could publish this one in this week please?

Motivation of my proactive work on this is because we yet got another ask by users and our team members, and I want to make it publish as soon as we could. Thanks for your patience and understanding again!

cc @eedugon
cc @alstolten

@kunisen
Copy link
Contributor

kunisen commented Jun 19, 2025

Also @shainaraskas could you help solve this please?

image

https://github.com/elastic/docs-content/actions/runs/15755256766

'connectors-kibana/email-action-type.md' is not a valid link in the 'kibana' cross link index: https://elastic-docs-link-index.s3.us-east-2.amazonaws.com/elastic/kibana/main/links.json

I have no idea about how to refer to a kibana doc in cloud docs...

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.

ECH - Promote KB about allocator moving nodes due to essential system maintenance
5 participants