Doc:Replace plugin_header file with plugin_header-integration file #34
Conversation
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
Integration plugins need a header that is different from the stand-alone plugin header. The plugin docs links should point to the integration repo rather than the stand-alone input and output repos. The header also adds a note that the plugin is part of an integration rather than stand-alone. The new header included in this work was added with Logstash #11891.
This was referenced Aug 18, 2020
jsvd approved these changes Aug 20, 2020
There was a problem hiding this comment.
overall LGTM. just to confirm, we don't need the :integration: rabbitmq header on the index.asciidoc, right?
Correct! The new :integration: attribute gives us a way to distinguish between plugins and integrations, especially in the case of jdbc where the integration and plugin names aren't 1:1 matches. So the plugins need the integration header to correctly point back to the integration. The integrations are working as designed. This is exactly the kind of thoughtful inquiry I was expecting from you to help ensure that we had thought through all the implications. Thanks for asking! |
| PUBLISHED: |
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
2 participants
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.
Integration plugins need a header that is different from the stand-alone plugin
header. The plugin docs links should point to the integration repo rather than the
stand-alone input and output repos. The header also adds a note that the plugin
is part of an integration rather than stand-alone.
The new header included in this work was added with elastic/logstash#11891 and elastic/logstash#12163 for the Logstash Reference, and elastic/logstash-docs#891 for the Versioned Plugin Reference.