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: 1 warning, 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. |
💡 Suggestions (2): Optional style improvements. Apply when helpful.
| File | Line | Rule | Message |
|---|---|---|---|
| deploy-manage/deploy/elastic-cloud/add-plugins-extensions.md | 17 | Elastic.Wordiness | Consider using 'unless' instead of 'except when'. |
| deploy-manage/deploy/elastic-cloud/add-plugins-extensions.md | 27 | Elastic.Wordiness | Consider using 'some' instead of 'Some of the'. |
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 😢
|
|
||
| In {{ech}} deployments, you can add plugins by selecting them from the available list. Plugin availability depends on your {{es}} version. | ||
|
|
||
| There are many suitable plugins, including: |
There was a problem hiding this comment.
I feel like suitable is a strange word here. we should swap to something that indicates that these are plugin categories?
| There are many suitable plugins, including: | |
| There are many categories of plugins available, including: |
| Plugins extend the core functionality of {{es}}. There are many suitable plugins, including: | ||
| Plugins extend the core functionality of {{es}}. {{ech}} simplifies plugin management by offering compatible plugins for your {{es}} version. These plugins are automatically upgraded with your deployment, except when there are breaking changes. | ||
|
|
||
| In {{ech}} deployments, you can add plugins by selecting them from the available list. Plugin availability depends on your {{es}} version. |
There was a problem hiding this comment.
I think this doesn't align with the content below because it's very "included plugin" centric. we might want to better split the provided plugin / custom plugin narrative a bit
| For a detailed guide with examples of using the {{ecloud}} API to create, get information about, update, and delete extensions and plugins, check [Managing plugins and extensions through the API](manage-plugins-extensions-through-api.md). | ||
|
|
||
| Plugins are not supported for {{kib}}. To learn more, check [Restrictions for {{es}} and {{kib}} plugins](restrictions-known-problems.md#ec-restrictions-plugins). | ||
| ## Add plugins provided with {{ech}} [ec-adding-elastic-plugins] |
There was a problem hiding this comment.
as much as this process is teeny-tiny, I think it breaks the IA to put it here. the other procedures are child pages, which would make this a disambiguation page. I suggest moving it down a level.
| ::: | ||
|
|
||
|
|
||
| ## Update your extension [ec-update-bundles-and-plugins] |
There was a problem hiding this comment.
does the extensions API stuff still belong on this page? if so, we have some heading gore we can probably clean up quick
| ::::{applies-item} { ess:, ece: } | ||
|
|
||
| 1. Create a [custom bundle](elasticsearch://reference/elasticsearch-plugins/plugin-management.md) that contains your `krb5.conf` and `keytab` files, and add it to your cluster. | ||
| 1. Add a custom bundle that contains your `krb5.conf` and `keytab` files to your cluster. For {{ech}}, follow [Upload custom plugins and bundles](/deploy-manage/deploy/elastic-cloud/upload-custom-plugins-bundles.md). For {{ece}}, follow [Add custom bundles and plugins](/deploy-manage/deploy/cloud-enterprise/add-custom-bundles-plugins.md). |
There was a problem hiding this comment.
these should eventually be parallelized, but I'd always avoid hardcoding the link names
| 1. Add a custom bundle that contains your `krb5.conf` and `keytab` files to your cluster. For {{ech}}, follow [Upload custom plugins and bundles](/deploy-manage/deploy/elastic-cloud/upload-custom-plugins-bundles.md). For {{ece}}, follow [Add custom bundles and plugins](/deploy-manage/deploy/cloud-enterprise/add-custom-bundles-plugins.md). | |
| 1. Add a custom bundle that contains your `krb5.conf` and `keytab` files to your cluster. For {{ech}}, follow [](/deploy-manage/deploy/elastic-cloud/upload-custom-plugins-bundles.md). For {{ece}}, follow [](/deploy-manage/deploy/cloud-enterprise/add-custom-bundles-plugins.md). |
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.