Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[PROPOSAL] Document adding new plugins to the OpenSearch distribution #216

Open
dblock opened this issue May 1, 2023 · 1 comment
Open
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@dblock
Copy link
Member

dblock commented May 1, 2023

What/Why

What are you proposing?

Document the steps that need to be taken to add an OpenSearch plugin into the distribution, including experimental plugins.

What users have asked for this feature?

There seems to be some confusion on experimental plugins mainly around the code / usage / testing perspective. What flag needs to be added, how to add it, how can it be tested, what level of testing is required etc.

What problems are you trying to solve?

It should be easy to a developer to bring to life a new plugin that is part of the distribution.

What is the developer experience going to be?

New section in https://github.com/opensearch-project/opensearch-plugins/blob/main/BUILDING.md.

Are there any security considerations?

We need to document whether, for example, a security review is required for experimental plugins.

@dblock dblock added documentation Improvements or additions to documentation enhancement New feature or request labels May 1, 2023
@bbarani
Copy link
Member

bbarani commented May 1, 2023

We should also tag the features on our roadmap with "Experimental" flag to distinguish those features from GA feature scheduled for specific version.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants