docs: added configuration docs (#1863)

* docs: added configuration docs * docs: add all config pages to ToCs
2020-08-09 22:34:04 +02:00
parent 39c3264de1
commit b25ffdc958
6 changed files with 358 additions and 0 deletions
@@ -0,0 +1,15 @@
+# Defining Configuration for your Plugin
+
+There is currently no tooling support or helpers for defining plugin
+configuration. But it's on the roadmap.
+
+Meanwhile, document the config values that you are reading in your plugin
+README.
+
+## Format
+
+When defining configuration for your plugin, keep keys camelCased and stick to
+existing casing conventions such as `baseUrl`.
+
+It is also usually best to prefer objects over arrays, as it makes it possible
+to override individual values using separate files or environment variables.