Conversation
👋 mini update that the bootlooping nodes troubleshooting doc applies to ECE not just ECH
Vale Linting ResultsSummary: 2 warnings, 11 suggestions found
|
| File | Line | Rule | Message |
|---|---|---|---|
| troubleshoot/monitoring/node-bootlooping.md | 47 | Elastic.Spelling | 'kubenetes' is a possible misspelling. |
| troubleshoot/monitoring/node-bootlooping.md | 93 | Elastic.Latinisms | Latin terms and abbreviations are a common source of confusion. Use 'using' instead of 'via'. |
💡 Suggestions (11)
| File | Line | Rule | Message |
|---|---|---|---|
| troubleshoot/monitoring/node-bootlooping.md | 20 | Elastic.WordChoice | Consider using 'can, might' instead of 'may', unless the term is in the UI. |
| troubleshoot/monitoring/node-bootlooping.md | 20 | Elastic.WordChoice | Consider using 'can, might' instead of 'may', unless the term is in the UI. |
| troubleshoot/monitoring/node-bootlooping.md | 20 | Elastic.WordChoice | Consider using 'cannot' instead of 'unable', unless the term is in the UI. |
| troubleshoot/monitoring/node-bootlooping.md | 20 | Elastic.WordChoice | Consider using 'can, might' instead of 'may', unless the term is in the UI. |
| troubleshoot/monitoring/node-bootlooping.md | 36 | Elastic.WordChoice | Consider using 'efficiently' instead of 'easily', unless the term is in the UI. |
| troubleshoot/monitoring/node-bootlooping.md | 44 | Elastic.WordChoice | Consider using 'cannot' instead of 'unable', unless the term is in the UI. |
| troubleshoot/monitoring/node-bootlooping.md | 93 | Elastic.WordChoice | Consider using 'can, might' instead of 'may', unless the term is in the UI. |
| troubleshoot/monitoring/node-bootlooping.md | 114 | Elastic.WordChoice | Consider using 'can, might' instead of 'may', unless the term is in the UI. |
| troubleshoot/monitoring/node-bootlooping.md | 114 | Elastic.WordChoice | Consider using 'can, might' instead of 'may', unless the term is in the UI. |
| troubleshoot/monitoring/node-bootlooping.md | 181 | Elastic.WordChoice | Consider using 'can, might' instead of 'may', unless the term is in the UI. |
| troubleshoot/monitoring/node-bootlooping.md | 181 | Elastic.WordChoice | Consider using 'can, might' instead of 'may', unless the term is in the UI. |
The Vale linter checks documentation changes against the Elastic Docs style guide.
To use Vale locally or report issues, refer to Elastic style guide for Vale.
🔍 Preview links for changed docs |
marciw
left a comment
There was a problem hiding this comment.
There are currently 2 node bootlooping pages, and one is specific to ECE: https://www.elastic.co/docs/troubleshoot/deployments/cloud-enterprise/node-bootlooping
(the content is slightly different)
So I guess instead of changing the label of this one, consolidate the pages? Would require some effort, since we do still have separate ECE/ECH sections (not saying that's a good thing)
|
an xref might be a quick fix here - linking to the other doc so people who land on the wrong one can find the right one |
|
Oof 🥴, I didn't know Docs split out my one guide into two. I now understand why it's felt like I keep editing and then not finding my changes. Those docs have definitely drifted from each other as I was trying to add in searchability error strings. @shainaraskas will you kindly show me how to do the xref? TIL the docs builder site doesn't search which I guess helps explain why I always only find things once y'all link them to me or once they're finally linked in Slack, sorry 😂 |
|
@stefnestor fwiw, we didn't choose to split this page. it existed in the cloud docs and the ece docs (even though it was single-sourced). when the migration happened, this area got cleaned up, but re-merging these docs can be tricky so we still have some debt. When I say xref ("cross-reference"), I just mean adding a little note near the top (prob after the intro) saying that "This page explains how to troubleshoot node bootlooping for {{ech}}. For {{ece}}-specific instructions, refer to [link to other page]". And then doing the same for the ece page. would love that syntax site to become searchable. we're still a little far from there, but we have some of that content mirrored on our public site which is searchable (e.g. quick reference) |
|
👋 @shainaraskas & all, I appreciate your advisement! Node bootlooping can apply to ECE+ECH+ECK, so I've tried to deduplicate the ECH+ECE pages into the ECH page and add the supplemental ECK content to make it exhaustive. Only section "Expired custom plugins or bundles" is ECH+ECE specific. Does this suffice to consolidate those multiple pages into one? TIA! |
earlier comments addressed; will re-review later
Summary
👋 mini update that the bootlooping nodes troubleshooting doc applies to ECE not just ECH
Generative AI disclosure