Update python.d module checklist to match the current paths and… (#6874)
It never got updated when the repo got restructured a while back. This updates all the paths to match the current structure of the repository, and also updates the info about the makefile to reflect how things currently are handled.
Austin S. Hemmelgarn committed
Sep 17, 2019 at 11:14 UTC
0ef218eb7c9f34e06e784e02f882f1e9caecf2bd
1 file changed
+7
-7
collectors/python.d.plugin/README.md
+7
-7
@@ -223,12 +223,12 @@ This is a generic checklist for submitting a new Python plugin for Netdata. It
223
224
At minimum, to be buildable and testable, the PR needs to include:
225
226
-- The module itself, following proper naming conventions: `python.d/<module_dir>/<module_name>.chart.py`
227
-- A README.md file for the plugin under `python.d/<module_dir>`.
228
-- The configuration file for the module: `conf.d/python.d/<module_name>.conf`. Python config files are in YAML format, and should include comments describing what options are present. The instructions are also needed in the configuration section of the README.md
229
-- A basic configuration for the plugin in the appropriate global config file: `conf.d/python.d.conf`, which is also in YAML format. Either add a line that reads `# <module_name>: yes` if the module is to be enabled by default, or one that reads `<module_name>: no` if it is to be disabled by default.
230
-- A line for the plugin in `python.d/Makefile.am` under `dist_python_DATA`.
231
-- A line for the plugin configuration file in `conf.d/Makefile.am`, under `dist_pythonconfig_DATA`
232
-- Optionally, chart information in `web/dashboard_info.js`. This generally involves specifying a name and icon for the section, and may include descriptions for the section or individual charts.
226
+- The module itself, following proper naming conventions: `collectors/python.d.plugin/<module_dir>/<module_name>.chart.py`
227
+- A README.md file for the plugin under `collectors/python.d.plugin/<module_dir>`.
228
+- The configuration file for the module: `collectors/python.d.plugin/<module_dir>/<module_name>.conf`. Python config files are in YAML format, and should include comments describing what options are present. The instructions are also needed in the configuration section of the README.md
229
+- A basic configuration for the plugin in the appropriate global config file: `collectors/python.d.plugin/python.d.conf`, which is also in YAML format. Either add a line that reads `# <module_name>: yes` if the module is to be enabled by default, or one that reads `<module_name>: no` if it is to be disabled by default.
230
+- A makefile for the plugin at `collectors/python.d.plugin/<module_dir>/Makefile.inc`. Check an existing plugin for what this should look like.
231
+- A line in `collectors/python.d.plugin/Makefile.am` including the above-mentioned makefile. Place it with the other plugin includes (please keep the includes sorted alphabetically).
232
+- Optionally, chart information in `web/gui/dashboard_info.js`. This generally involves specifying a name and icon for the section, and may include descriptions for the section or individual charts.
233
234
[](<>)