Skip to content

Commit 9a5199f

Browse files
authored
Docs: Remove references to elasticsearch directory in plugins (#28647)
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.
1 parent 3cd4da7 commit 9a5199f

File tree

3 files changed

+10
-18
lines changed

3 files changed

+10
-18
lines changed

buildSrc/src/main/resources/meta-plugin-descriptor.properties

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,12 @@
11
# Elasticsearch meta plugin descriptor file
2-
# This file must exist as 'meta-plugin-descriptor.properties' in a folder named `elasticsearch`.
2+
# This file must exist as 'meta-plugin-descriptor.properties' inside a plugin.
33
#
44
### example meta plugin for "meta-foo"
55
#
66
# meta-foo.zip <-- zip file for the meta plugin, with this structure:
7-
#|____elasticsearch/
8-
#| |____ <bundled_plugin_1> <-- The plugin files for bundled_plugin_1 (the content of the elastisearch directory)
9-
#| |____ <bundled_plugin_2> <-- The plugin files for bundled_plugin_2
10-
#| |____ meta-plugin-descriptor.properties <-- example contents below:
7+
# |____ <bundled_plugin_1> <-- The plugin files for bundled_plugin_1
8+
# |____ <bundled_plugin_2> <-- The plugin files for bundled_plugin_2
9+
# |____ meta-plugin-descriptor.properties <-- example contents below:
1110
#
1211
# description=My meta plugin
1312
# name=meta-foo

buildSrc/src/main/resources/plugin-descriptor.properties

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,12 @@
11
# Elasticsearch plugin descriptor file
2-
# This file must exist as 'plugin-descriptor.properties' in a folder named `elasticsearch`
3-
# inside all plugins.
2+
# This file must exist as 'plugin-descriptor.properties' inside a plugin.
43
#
54
### example plugin for "foo"
65
#
76
# foo.zip <-- zip file for the plugin, with this structure:
8-
#|____elasticsearch/
9-
#| |____ <arbitrary name1>.jar <-- classes, resources, dependencies
10-
#| |____ <arbitrary nameN>.jar <-- any number of jars
11-
#| |____ plugin-descriptor.properties <-- example contents below:
7+
# |____ <arbitrary name1>.jar <-- classes, resources, dependencies
8+
# |____ <arbitrary nameN>.jar <-- any number of jars
9+
# |____ plugin-descriptor.properties <-- example contents below:
1210
#
1311
# classname=foo.bar.BazPlugin
1412
# description=My cool plugin

docs/plugins/authors.asciidoc

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -20,15 +20,10 @@ These examples provide the bare bones needed to get started. For more
2020
information about how to write a plugin, we recommend looking at the plugins
2121
listed in this documentation for inspiration.
2222

23-
[float]
24-
=== Plugin Structure
25-
26-
All plugin files must be contained in a directory called `elasticsearch`.
27-
2823
[float]
2924
=== Plugin descriptor file
3025

31-
All plugins must contain a file called `plugin-descriptor.properties` in the folder named `elasticsearch`.
26+
All plugins must contain a file called `plugin-descriptor.properties`.
3227
The format for this file is described in detail in this example:
3328

3429
["source","properties"]
@@ -63,7 +58,7 @@ of nonnegative decimal integers separated by "."'s and may have leading zeros.
6358

6459
|=======================================================================
6560

66-
Note that only jar files in the 'elasticsearch' directory are added to the classpath for the plugin!
61+
Note that only jar files at the root of the plugin are added to the classpath for the plugin!
6762
If you need other resources, package them into a resources jar.
6863

6964
[IMPORTANT]

0 commit comments

Comments
 (0)