From a298090f718ed07e86e93396a2e303a52582b29a Mon Sep 17 00:00:00 2001 From: Monica Kugler <111086853+mnkugler@users.noreply.github.com> Date: Wed, 30 Nov 2022 19:13:04 -0500 Subject: [PATCH] Removing folders verbiage from CONVENTIONS.md We are removing the folders naming requirements since we are moving to one plugin per repo https://github.com/opensearch-project/opensearch-build/issues/2188 Signed-off-by: Monica Kugler --- CONVENTIONS.md | 15 --------------- 1 file changed, 15 deletions(-) diff --git a/CONVENTIONS.md b/CONVENTIONS.md index 90b8c08..3bb9550 100644 --- a/CONVENTIONS.md +++ b/CONVENTIONS.md @@ -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) @@ -81,18 +78,6 @@ For example, [dashboards-notebooks/opensearch_dashboards.json](https://github.co - Artifacts are of the `-` 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`.