Clarify plugin repo naming conventions #27
Conversation
lukas-vlcek
changed the title
lukas-vlcek
force-pushed
the
naming_conventions
branch
from
6e940b5 to
1ff190b
Compare
|
In the PR I briefly mention that versioning policy should be documented for (3rd party) plugins but no specific instructions/examples are provided. |
lukas-vlcek
force-pushed
the
naming_conventions
branch
2 times, most recently
from
f91a0c7 to
1bb8913
Compare
|
|
||
| Depending on the plugin relationship with the OpenSearch organization we currently recommend the following naming conventions and optional follow-up checks: | ||
|
|
||
| ### Official plugins |
There was a problem hiding this comment.
I don't love the name "Official". How about "Plugins Released with OpenSearch", of which there are 2 kinds, native and non-native?
There was a problem hiding this comment.
I was following naming pattern from InstallPluginCommand.java, see the JavaDoc and var name (also in online docs). Shall we rename in the install tool source code as well?
I would use "Native" and "Thirdparty" plugins. WDYT?
There was a problem hiding this comment.
I see. That can be a separate PR. Let's leave it this way here, consider following up?
There was a problem hiding this comment.
consider following up?
Yes, naming should be addressed in different PR.
lukas-vlcek
force-pushed
the
naming_conventions
branch
from
1bb8913 to
2c44c63
Compare
OpenSearch plugins can "live" either inside the OpenSearch organization or outside it. This is the difference between official plugins and 3rd party plugins that are maintained in independent repositories. Currently, these two types of plugins are not recommended to share exactly the same repo naming conventions (this might change but not in the near-term future). If needed, the 3rd party plugin authors should also follow up with several extra checks in making sure the formal processes are correctly aligned with the community needs (such as Code of Conduct, Security Policy, Trademarks and Attributions). Closes opensearch-project#23 Signed-off-by: Lukáš Vlček <lukas.vlcek@aiven.io>
lukas-vlcek
force-pushed
the
naming_conventions
branch
from
2c44c63 to
79252f7
Compare
Signed-off-by: Lukáš Vlček lukas.vlcek@aiven.io
Description
OpenSearch plugins can "live" either inside the OpenSearch organization or outside it. This is the difference between official plugins and 3rd party plugins that are maintained in independent repositories.
Currently, these two types of plugins are not recommended to share exactly the same repo naming conventions (this might change but not in the near-term future). If needed, the 3rd party plugin authors should also follow up with several extra checks in making sure the formal processes are correctly aligned with the community needs (such as Code of Conduct, Security Policy, Trademarks and Attributions).
Issues Resolved
Closes #23
Check List
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.