See opensearch-project#98

We should be encouraging users to create plugins outside the opensearch-project. We still need a formal process to include plugins into the project, but it is a good idea to avoid contradicting documentation. this commit resolves some of this ambiguity.

Signed-off-by: AmiStrn <123amitai@gmail.com>

README.md

@@ -66,15 +66,15 @@ This is the file tree structure of the source code, as you can see there are som
     |-- main
     |   `-- java
     |       `-- org
-    |           `-- opensearch
+    |           `-- example
     |               `-- path
     |                   `-- to
     |                       `-- plugin
     |                           `-- RenamePlugin.java
     |-- test
     |   `-- java
     |       `-- org
-    |           `-- opensearch
+    |           `-- example
     |               `-- path
     |                   `-- to
     |                       `-- plugin
@@ -83,7 +83,7 @@ This is the file tree structure of the source code, as you can see there are som
     `-- yamlRestTest
         |-- java
         |   `-- org
-        |       `-- opensearch
+        |       `-- example
         |           `-- path
         |               `-- to
         |                   `-- plugin
@@ -100,29 +100,35 @@ Now that you have named the repo, you can change the plugin class `RenamePlugin.
 Change `RenamePluginIT.java`, `RenameTests.java`, and `RenameClientYamlTestSuiteIT.java` accordingly, keeping the `PluginIT`, `Tests`, and `ClientYamlTestSuiteIT` suffixes.
 
 ### Plugin Path 
-Notice these paths in the source tree:
-```
--- path
-   `-- to
-       `-- plugin
-```
-
-Let's call this our *plugin path*, as the plugin class would be installed in OpenSearch under that path.
-This can be an existing path in OpenSearch, or it can be a unique path for your plugin. We recommend changing it to something meaningful.
-Change all these path occurrences to match the path you chose for your plugin:
-- Chose a new plugin path
-- Go to the `build.gradle` file and update the `pathToPlugin` param with the path you've chosen (use dotted notation)
-- Run `./gradlew preparePluginPathDirs` in the terminal
-- Move the java classes into the new directories (will require to edit the `package` name in the files as well)
-- Delete the old directories
+You will need to change these paths in the source tree:
+
+1) Package Path
+    ```
+    `-- org
+        `-- example
+    ```
+    Let's call this our *package path*. In Java, package naming convention is to use a domain name in order to create a unique package name.
+    This is normally your organization's domain.
+
+2) Plugin Path
+    ```
+     `-- path
+         `-- to
+             `-- plugin
+    ```
+    Let's call this our *plugin path*, as the plugin class would be installed in OpenSearch under that path.
+    This can be an existing path in OpenSearch, or it can be a unique path for your plugin. We recommend changing it to something meaningful.
+
+3) Change all these path occurrences to match your chosen path and naming by following [this](#update-the-buildgradle-file) section
 
 ### Update the `build.gradle` file
 
-Update the following section, using the new repository name and description, plugin class name, and plugin path:
+Update the following section, using the new repository name and description, plugin class name, package and plugin paths:
 
 ```
 def pluginName = 'rename'                // Can be the same as new repo name except including words `plugin` or `OpenSearch` is discouraged
 def pluginDescription = 'Custom plugin'  // Can be same as new repo description
+def packagePath = 'org.example'          // The package name for your plugin (convention is to use your organization's domain name)
 def pathToPlugin = 'path.to.plugin'      // The path you chose for the plugin
 def pluginClassName = 'RenamePlugin'     // The plugin class name
 ```
@@ -134,6 +140,10 @@ Next update the version of OpenSearch you want the plugin to be installed into.
     }
 ```
 
+- Run `./gradlew preparePluginPathDirs` in the terminal
+- Move the java classes into the new directories (will require to edit the `package` name in the files as well)
+- Delete the old directories (the `org.example` directories)
+
 ### Update the tests
 Notice that in the tests we are checking that the plugin was installed by sending a GET `/_cat/plugins` request to the cluster and expecting `rename` to be in the response.
 In order for the tests to pass you must change `rename` in `RenamePluginIT.java` and in `10_basic.yml` to be the `pluginName` you defined in the `build.gradle` file in the previous section.
@@ -170,9 +180,9 @@ tasks.register("preparePluginPathDirs") {
     mustRunAfter clean
     doLast {
         def newPath = pathToPlugin.replace(".", "/")
-        mkdir "src/main/java/org/opensearch/$newPath"
-        mkdir "src/test/java/org/opensearch/$newPath"
-        mkdir "src/yamlRestTest/java/org/opensearch/$newPath"
+        mkdir "src/main/java/$packagePath/$newPath"
+        mkdir "src/test/java/$packagePath/$newPath"
+        mkdir "src/yamlRestTest/java/$packagePath/$newPath"
     }
 }
 ```
@@ -190,6 +200,20 @@ Also, the **OpenSearch version** in the `Build OpenSearch` and in the `Build and
 
 To view more complex CI examples you may want to checkout the workflows in official OpenSearch plugins, such as [anomaly-detection](https://github.com/opensearch-project/anomaly-detection/blob/main/.github/workflows/test_build_multi_platform.yml).
 
+## Your Plugin's License
+Source code files in this template contains the following header:
+```
+/*
+* SPDX-License-Identifier: Apache-2.0
+*
+* The OpenSearch Contributors require contributions made to
+* this file be licensed under the Apache-2.0 license or a
+* compatible open source license.
+  */
+```
+This plugin template is indeed open-sourced while you might choose to use it to create a proprietary plugin.
+Be sure to update your plugin to meet any licensing requirements you may be subject to.
+
 ## License
 This code is licensed under the Apache 2.0 License. See [LICENSE.txt](LICENSE.txt).
 

build.gradle

@@ -9,7 +9,7 @@ apply plugin: 'opensearch.pluginzip'
 
 def pluginName = 'rename'
 def pluginDescription = 'Custom plugin'
-def projectPath = 'org.opensearch'
+def packagePath = 'org.example'
 def pathToPlugin = 'path.to.plugin'
 def pluginClassName = 'RenamePlugin'
 group = "RenameGroup"
@@ -23,9 +23,9 @@ tasks.register("preparePluginPathDirs") {
     mustRunAfter clean
     doLast {
         def newPath = pathToPlugin.replace(".", "/")
-        mkdir "src/main/java/org/opensearch/$newPath"
-        mkdir "src/test/java/org/opensearch/$newPath"
-        mkdir "src/yamlRestTest/java/org/opensearch/$newPath"
+        mkdir "src/main/java/$packagePath/$newPath"
+        mkdir "src/test/java/$packagePath/$newPath"
+        mkdir "src/yamlRestTest/java/$packagePath/$newPath"
     }
 }
 
@@ -55,7 +55,7 @@ publishing {
 opensearchplugin {
     name pluginName
     description pluginDescription
-    classname "${projectPath}.${pathToPlugin}.${pluginClassName}"
+    classname "${packagePath}.${pathToPlugin}.${pluginClassName}"
     licenseFile rootProject.file('LICENSE.txt')
     noticeFile rootProject.file('NOTICE.txt')
 }

src/main/java/org/opensearch/path/to/plugin/RenamePlugin.java → src/main/java/org/example/path/to/plugin/RenamePlugin.java

@@ -5,7 +5,7 @@
  * this file be licensed under the Apache-2.0 license or a
  * compatible open source license.
  */
-package org.opensearch.path.to.plugin;
+package org.example.path.to.plugin;
 
 import org.opensearch.plugins.Plugin;
 

src/test/java/org/opensearch/path/to/plugin/RenamePluginIT.java → src/test/java/org/example/path/to/plugin/RenamePluginIT.java

@@ -5,7 +5,7 @@
  * this file be licensed under the Apache-2.0 license or a
  * compatible open source license.
  */
-package org.opensearch.path.to.plugin;
+package org.example.path.to.plugin;
 
 import com.carrotsearch.randomizedtesting.annotations.ThreadLeakScope;
 import org.apache.hc.core5.http.ParseException;

src/test/java/org/opensearch/path/to/plugin/RenameTests.java → src/test/java/org/example/path/to/plugin/RenameTests.java

@@ -5,7 +5,7 @@
  * this file be licensed under the Apache-2.0 license or a
  * compatible open source license.
  */
-package org.opensearch.path.to.plugin;
+package org.example.path.to.plugin;
 
 import org.opensearch.test.OpenSearchTestCase;
 

src/yamlRestTest/java/org/opensearch/path/to/plugin/RenameClientYamlTestSuiteIT.java → src/yamlRestTest/java/org/example/path/to/plugin/RenameClientYamlTestSuiteIT.java

@@ -5,7 +5,7 @@
  * this file be licensed under the Apache-2.0 license or a
  * compatible open source license.
  */
-package org.opensearch.path.to.plugin;
+package org.example.path.to.plugin;
 
 import com.carrotsearch.randomizedtesting.annotations.Name;
 import com.carrotsearch.randomizedtesting.annotations.ParametersFactory;