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.

Sign up for GitHub

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

Jump to bottom

add convention for plugin location (relates to #13879) #233

Merged
merged 5 commits into from
Jun 17, 2024
Merged

add convention for plugin location (relates to #13879) #233

Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
f86b039
add convention for plugin location (relates to #13879)
AmiStrn Jun 4, 2024
9ee2e3a
Update CONVENTIONS.md
AmiStrn Jun 4, 2024
0a22fc0
Update CONVENTIONS.md
AmiStrn Jun 4, 2024
e3fe8bf
added to toc
AmiStrn Jun 4, 2024
254ac97
fixing minor comments to PR
AmiStrn Jun 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions CONVENTIONS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
- [Plugin Location](#plugin-location)
- [Plugin Naming Conventions](#plugin-naming-conventions)
- [GitHub](#github)
- [OpenSearch Plugins](#opensearch-plugins)
Expand All @@ -15,6 +16,12 @@
- [Identifiers](#identifiers)
- [Variables](#variables)

## Plugin Location
AmiStrn marked this conversation as resolved.
Show resolved Hide resolved
AmiStrn marked this conversation as resolved.
Show resolved Hide resolved

- Most plugins should start in a repository outside of the OpenSearch project. This allows for rapid iteration during initial development without the overhead of being an official part of the project.
AmiStrn marked this conversation as resolved.
Show resolved Hide resolved
- Plugins can be later ported into the OpenSearch Project on a case-by-case basis. A formal path for this process is yet to be created.
AmiStrn marked this conversation as resolved.
Show resolved Hide resolved
- Do not add new plugins to the [plugins folder](https://github.com/opensearch-project/OpenSearch/tree/main/plugins) within the core OpenSearch repository. The maintainers likely do not have domain expertise in your new optional plugin. If you think it should be there anyway, please explain why in the RFC stage. In any case, it is recommended to start outside the project.
AmiStrn marked this conversation as resolved.
Show resolved Hide resolved

## Plugin Naming Conventions

### GitHub
Expand Down
Loading