Skip to content

Commit

Permalink
Removing folders verbiage from CONVENTIONS.md
Browse files Browse the repository at this point in the history
We are removing the folders naming requirements since we are moving to one plugin per repo opensearch-project/opensearch-build#2188

Signed-off-by: Monica Kugler <[email protected]>
  • Loading branch information
mnkugler authored Dec 1, 2022
1 parent 5067091 commit a298090
Showing 1 changed file with 0 additions and 15 deletions.
15 changes: 0 additions & 15 deletions CONVENTIONS.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,6 @@
- [Artifacts](#artifacts)
- [OpenSearch Plugins](#opensearch-plugins-2)
- [OpenSearch Dashboards Plugins](#opensearch-dashboards-plugins)
- [Folders](#folders)
- [OpenSearch Plugins](#opensearch-plugins-3)
- [OpenSearch Dashboard Plugins](#opensearch-dashboard-plugins-2)
- [Classes](#classes)
- [Settings](#settings)
- [APIs](#apis)
Expand Down Expand Up @@ -81,18 +78,6 @@ For example, [dashboards-notebooks/opensearch_dashboards.json](https://github.co

- Artifacts are of the `<package name>-<version>` format, e.g. `notebooks-dashboards-1.0.0.0-beta1.zip`.

### Folders

#### OpenSearch Plugins

- Always use kebab-case.
- Include full plugin name, e.g. `plugins/opensearch-knn`.

#### OpenSearch Dashboard Plugins

- Always use kebab-case.
- Include full plugin name, e.g. `plugins/notebooks-dashboards`. The change to automatically convert folders to kebab-case is still pending, see [OpenSearch-Dashboards#322](https://github.com/opensearch-project/OpenSearch-Dashboards/issues/322).

### Classes

- Lowercase namespaces, e.g. `org.opensearch.jobscheduler`.
Expand Down

0 comments on commit a298090

Please sign in to comment.