From 6cb7136099398ec060bebfe9d50094cd2d37f747 Mon Sep 17 00:00:00 2001 From: Ryan Ernst Date: Mon, 12 Feb 2018 17:56:21 -0800 Subject: [PATCH 1/2] Docs: Remove references to elasticsearch directory in plugins This directory was removed from plugins in #28589, but docs still referenced it. This commit cleans up the plugin author docs to no longer refer to it. --- docs/plugins/authors.asciidoc | 9 ++------- 1 file changed, 2 insertions(+), 7 deletions(-) diff --git a/docs/plugins/authors.asciidoc b/docs/plugins/authors.asciidoc index 059d9a5bf6817..a83a950f55528 100644 --- a/docs/plugins/authors.asciidoc +++ b/docs/plugins/authors.asciidoc @@ -20,15 +20,10 @@ These examples provide the bare bones needed to get started. For more information about how to write a plugin, we recommend looking at the plugins listed in this documentation for inspiration. -[float] -=== Plugin Structure - -All plugin files must be contained in a directory called `elasticsearch`. - [float] === Plugin descriptor file -All plugins must contain a file called `plugin-descriptor.properties` in the folder named `elasticsearch`. +All plugins must contain a file called `plugin-descriptor.properties`. The format for this file is described in detail in this example: ["source","properties",subs="attributes"] @@ -63,7 +58,7 @@ of nonnegative decimal integers separated by "."'s and may have leading zeros. |======================================================================= -Note that only jar files in the 'elasticsearch' directory are added to the classpath for the plugin! +Note that only jar files at the root of the plugin are added to the classpath for the plugin! If you need other resources, package them into a resources jar. [IMPORTANT] From 65d9679f6a6eeaf28518dddc10fa2c9c0fd353c6 Mon Sep 17 00:00:00 2001 From: Ryan Ernst Date: Mon, 12 Feb 2018 20:45:06 -0800 Subject: [PATCH 2/2] more elasticsearch dir refs --- .../main/resources/meta-plugin-descriptor.properties | 9 ++++----- .../src/main/resources/plugin-descriptor.properties | 10 ++++------ 2 files changed, 8 insertions(+), 11 deletions(-) diff --git a/buildSrc/src/main/resources/meta-plugin-descriptor.properties b/buildSrc/src/main/resources/meta-plugin-descriptor.properties index 16dbe4c38a55b..950cb03240083 100644 --- a/buildSrc/src/main/resources/meta-plugin-descriptor.properties +++ b/buildSrc/src/main/resources/meta-plugin-descriptor.properties @@ -1,13 +1,12 @@ # Elasticsearch meta plugin descriptor file -# This file must exist as 'meta-plugin-descriptor.properties' in a folder named `elasticsearch`. +# This file must exist as 'meta-plugin-descriptor.properties' inside a plugin. # ### example meta plugin for "meta-foo" # # meta-foo.zip <-- zip file for the meta plugin, with this structure: -#|____elasticsearch/ -#| |____ <-- The plugin files for bundled_plugin_1 (the content of the elastisearch directory) -#| |____ <-- The plugin files for bundled_plugin_2 -#| |____ meta-plugin-descriptor.properties <-- example contents below: +# |____ <-- The plugin files for bundled_plugin_1 +# |____ <-- The plugin files for bundled_plugin_2 +# |____ meta-plugin-descriptor.properties <-- example contents below: # # description=My meta plugin # name=meta-foo diff --git a/buildSrc/src/main/resources/plugin-descriptor.properties b/buildSrc/src/main/resources/plugin-descriptor.properties index d9c51b3a73507..dd1a267c0b38e 100644 --- a/buildSrc/src/main/resources/plugin-descriptor.properties +++ b/buildSrc/src/main/resources/plugin-descriptor.properties @@ -1,14 +1,12 @@ # Elasticsearch plugin descriptor file -# This file must exist as 'plugin-descriptor.properties' in a folder named `elasticsearch` -# inside all plugins. +# This file must exist as 'plugin-descriptor.properties' inside a plugin. # ### example plugin for "foo" # # foo.zip <-- zip file for the plugin, with this structure: -#|____elasticsearch/ -#| |____ .jar <-- classes, resources, dependencies -#| |____ .jar <-- any number of jars -#| |____ plugin-descriptor.properties <-- example contents below: +# |____ .jar <-- classes, resources, dependencies +# |____ .jar <-- any number of jars +# |____ plugin-descriptor.properties <-- example contents below: # # classname=foo.bar.BazPlugin # description=My cool plugin