Deduplicate some of the Plugin management content#7101
Conversation
Elastic Docs AI PR menuCheck the box to run an AI review for this pull request.
Powered by GitHub Agentic Workflows and docs-actions. For more information, reach out to the docs team. |
Elastic Docs Style Checker (Vale)Summary: 3 warnings, 2 suggestions found
|
| File | Line | Rule | Message |
|---|---|---|---|
| deploy-manage/deploy/cloud-enterprise/add-plugins.md | 3 | Elastic.MappedPages | mapped_pages should only be added or updated in rare scenarios. Talk with your local technical writer before pushing changes to this key. |
| deploy-manage/deploy/elastic-cloud/add-plugins-provided-with-ech.md | 3 | Elastic.MappedPages | mapped_pages should only be added or updated in rare scenarios. Talk with your local technical writer before pushing changes to this key. |
| deploy-manage/deploy/elastic-cloud/upload-custom-plugins-bundles.md | 23 | Elastic.BritishSpellings | Use American English spelling 'among' instead of British English 'amongst'. |
💡 Suggestions (2): Optional style improvements. Apply when helpful.
| File | Line | Rule | Message |
|---|---|---|---|
| deploy-manage/deploy/elastic-cloud/upload-custom-plugins-bundles.md | 161 | Elastic.WordChoice | Consider using 'can, might' instead of 'may', unless the term is in the UI. |
| deploy-manage/deploy/elastic-cloud/upload-custom-plugins-bundles.md | 166 | Elastic.Semicolons | Use semicolons judiciously. |
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.
shainaraskas
left a comment
shainaraskas
left a comment
There was a problem hiding this comment.
I think you need to tweak the ECH plugin overview page to make the pathways a little clearer before 🚢 :)
| You can also [create](elasticsearch://extend/index.md) and add custom plugins. | ||
|
|
||
| To add plugins when creating a new deployment: | ||
| ## Add plugins when creating a new {{ece}} deployment |
There was a problem hiding this comment.
I prefer the acronym here but my pal claude tells me it's worse for llmo 😢
There was a problem hiding this comment.
🤔 Interesting, my agent says:
"Use this if chunks are often heading-only or heading + steps without the H1 (floating-only). Better for RAG and external search snippets.
For LLM/RAG: repeating {{ece}} in H2s is defensive and helps when chunks are retrieved out of context."
shainaraskas
left a comment
shainaraskas
left a comment
There was a problem hiding this comment.
couple of additional comments for ya :)
|
Thank you, @shainaraskas 🙏 |
shainaraskas
left a comment
shainaraskas
left a comment
There was a problem hiding this comment.
👋 couple more comments. until we have a hub for this, I think the overviews need to do a little more conceptual heavy lifting. these could be the foundations for the future doc hopefully
Done, thank you! Please have another 👀 when you get the chance @shainaraskas
Yes, that's true. I hope it's an improvement for the current state of the docs, anyway. :) |
2 participants
Summary
Part of #423
This PR moves Managing plugins for ECE from the reference docs to its corresponding page in the narrative docs.
It does the same for the Managing plugins for ECH section, and moves it to its corresponding ECH page.
Some of the ECH content, such as enabling plugins for a deployment was moved into a snippet as it duplicates the same little task on the Upload custom plugins and bundles page.
Generative AI disclosure
Used Cursor's Auto mode to find snippet opportunities for duplicated content.