Create a new single entry point to plugins and bundles - #7959
Draft
yetanothertw wants to merge 4 commits into
Draft
Create a new single entry point to plugins and bundles#7959yetanothertw wants to merge 4 commits into
yetanothertw wants to merge 4 commits into
Conversation
Contributor
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. |
Contributor
Contributor
Elastic Docs Style Checker (Vale)Summary: 14 warnings, 15 suggestions found
|
| File | Line | Rule | Message |
|---|---|---|---|
| deploy-manage/plugins-and-bundles.md | 2 | Elastic.MappedPages | Avoid editing mapped_pages unless you are preserving an existing URL mapping. Talk with your local technical writer before changing this key. |
| deploy-manage/plugins-and-bundles/cloud-enterprise/add-custom-bundles-plugins.md | 94 | Elastic.DontUse | Don't use 'just'. Choose a more precise or reader-focused term. |
| deploy-manage/plugins-and-bundles/cloud-enterprise/add-custom-bundles-plugins.md | 268 | Elastic.DontUse | Don't use 'and/or'. Choose a more precise or reader-focused term. |
| deploy-manage/plugins-and-bundles/cloud-enterprise/add-plugins-provided-with-ece.md | 4 | Elastic.MappedPages | Avoid editing mapped_pages unless you are preserving an existing URL mapping. Talk with your local technical writer before changing this key. |
| deploy-manage/plugins-and-bundles/cloud-on-k8s/custom-configuration-files-plugins.md | 2 | Elastic.MappedPages | Avoid editing mapped_pages unless you are preserving an existing URL mapping. Talk with your local technical writer before changing this key. |
| deploy-manage/plugins-and-bundles/cloud-on-k8s/init-containers-for-plugin-downloads.md | 2 | Elastic.MappedPages | Avoid editing mapped_pages unless you are preserving an existing URL mapping. Talk with your local technical writer before changing this key. |
| deploy-manage/plugins-and-bundles/self-managed/custom-url.md | 2 | Elastic.MappedPages | Avoid editing mapped_pages unless you are preserving an existing URL mapping. Talk with your local technical writer before changing this key. |
| deploy-manage/plugins-and-bundles/self-managed/install-multiple-plugins.md | 2 | Elastic.MappedPages | Avoid editing mapped_pages unless you are preserving an existing URL mapping. Talk with your local technical writer before changing this key. |
| deploy-manage/plugins-and-bundles/self-managed/install-plugins.md | 2 | Elastic.MappedPages | Avoid editing mapped_pages unless you are preserving an existing URL mapping. Talk with your local technical writer before changing this key. |
| deploy-manage/plugins-and-bundles/self-managed/list-remove-update.md | 2 | Elastic.MappedPages | Avoid editing mapped_pages unless you are preserving an existing URL mapping. Talk with your local technical writer before changing this key. |
| deploy-manage/plugins-and-bundles/self-managed/manage-plugins-using-configuration-file.md | 2 | Elastic.MappedPages | Avoid editing mapped_pages unless you are preserving an existing URL mapping. Talk with your local technical writer before changing this key. |
| deploy-manage/plugins-and-bundles/self-managed/mandatory-plugins.md | 2 | Elastic.MappedPages | Avoid editing mapped_pages unless you are preserving an existing URL mapping. Talk with your local technical writer before changing this key. |
| deploy-manage/plugins-and-bundles/self-managed/other-command-line-parameters.md | 2 | Elastic.MappedPages | Avoid editing mapped_pages unless you are preserving an existing URL mapping. Talk with your local technical writer before changing this key. |
| deploy-manage/plugins-and-bundles/self-managed/plugins-directory.md | 2 | Elastic.MappedPages | Avoid editing mapped_pages unless you are preserving an existing URL mapping. Talk with your local technical writer before changing this key. |
💡 Suggestions (15): Optional style improvements. Apply when helpful.
| File | Line | Rule | Message |
|---|---|---|---|
| deploy-manage/deploy/cloud-enterprise/configure-deployment.md | 21 | Elastic.WordChoice | Consider using 'deactivate, deselect, hide, turn off' instead of 'disable', unless the term is in the UI. |
| deploy-manage/deploy/cloud-enterprise/post-installation-steps.md | 21 | Elastic.Versions | Use 'later version' instead of 'newer version' when referring to versions. |
| deploy-manage/deploy/cloud-on-k8s/k8s-service-mesh-istio.md | 133 | Elastic.WordChoice | Consider using 'can, might' instead of 'may', unless the term is in the UI. |
| deploy-manage/plugins-and-bundles.md | 53 | Elastic.Wordiness | Consider using 'unless' instead of 'except when'. |
| deploy-manage/plugins-and-bundles.md | 104 | Elastic.Semicolons | Use semicolons sparingly. Consider splitting the sentence or using a comma or conjunction. |
| deploy-manage/plugins-and-bundles/cloud-enterprise/add-plugins.md | 29 | Elastic.Wordiness | Consider using 'unless' instead of 'except when'. |
| deploy-manage/plugins-and-bundles/cloud-on-k8s/manage-plugins.md | 15 | Elastic.Semicolons | Use semicolons sparingly. Consider splitting the sentence or using a comma or conjunction. |
| deploy-manage/plugins-and-bundles/self-managed/install-multiple-plugins.md | 29 | Elastic.Wordiness | Consider using 'all' instead of 'all of '. |
| deploy-manage/plugins-and-bundles/self-managed/manage-plugins-using-configuration-file.md | 24 | Elastic.Semicolons | Use semicolons sparingly. Consider splitting the sentence or using a comma or conjunction. |
| deploy-manage/plugins-and-bundles/self-managed/manage-plugins-using-configuration-file.md | 24 | Elastic.WordChoice | Consider using 'deactivated, deselected, hidden, turned off, unavailable' instead of 'disabled', unless the term is in the UI. |
| deploy-manage/plugins-and-bundles/self-managed/manage-plugins.md | 23 | Elastic.Repetition | "in" is repeated. |
| deploy-manage/plugins-and-bundles/self-managed/manage-plugins.md | 23 | Elastic.Semicolons | Use semicolons sparingly. Consider splitting the sentence or using a comma or conjunction. |
| deploy-manage/plugins-and-bundles/self-managed/manage-plugins.md | 23 | Elastic.WordChoice | Consider using 'deactivated, deselected, hidden, turned off, unavailable' instead of 'disabled', unless the term is in the UI. |
| deploy-manage/plugins-and-bundles/self-managed/manage-plugins.md | 29 | Elastic.Semicolons | Use semicolons sparingly. Consider splitting the sentence or using a comma or conjunction. |
| deploy-manage/plugins-and-bundles/self-managed/other-command-line-parameters.md | 19 | 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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fixes #1075 and adds a single entry point for plugins and budles/configuration files in Elasticsearch. Currently these docs exist, but they're scattered around: some live in the
elasticsearchrepo and others in the dpeloy and configuration section for specific deployment types.Conceptual approach
The section was reorganized around one hub per audience decision, not per product page. The top-level plugins-and-bundles.md answers "what are plugins vs bundles, and which deployment type am I on"; each deployment type gets a mini-hub that answers "which path do I take here"; procedures live on children and stay procedure-only.
Terminology was made deliberate: plugin = Elasticsearch package, bundle = ZIP of config/data files (ECH/ECE only), extension = the ECH console/API umbrella for both. That lets each mini-hub frame its real choice:
provided vs customon ECH/ECE, and on ECK no catalog exists, so the only question is how the files reach the pod.For ECK specifically, the old combined page was split so pages match the comparison matrix: custom image (canonical how-to already lived in create-custom-images.md, so the hub links there rather than duplicating), init containers, and ConfigMaps/Secrets for config files only. Nav titles stay short; H1s are verb-led. Redirects and mapped_pages follow the canonical home for each procedure.
Pages touched
For previewing the changes start here: Plugins and bundles
Next steps
Outstanding task is to clean up the old plugin-management pages in the
elasticsearchrepo. Will open a separate PR for that.This would need to be reviewed by @/eedugon and @/shainaraskas before opening it up to the other teams (mostly for link-related updates).
Generative AI disclosure
Tool(s) and model(s) used: Cursor's auto agent to help track down links and information