From 1873fa94f309b4acc2c16eea2b26387d540ae55f Mon Sep 17 00:00:00 2001
From: Simon Rettberg
Date: Tue, 14 Jun 2016 17:13:54 +0200
Subject: Add documentation

---
 doc/enabling_modules | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)
 create mode 100644 doc/enabling_modules

(limited to 'doc/enabling_modules')

diff --git a/doc/enabling_modules b/doc/enabling_modules
new file mode 100644
index 00000000..dd36d000
--- /dev/null
+++ b/doc/enabling_modules
@@ -0,0 +1,16 @@
+As a convention, modules should be placed in another directory and then
+get selectively enabled by symlinking.
+Currently, all modules are placed in ./modules-available, and the symlinks
+reside in ./modules
+Note that you can name the symlink differently. The name of the symlink
+will define by what identifier the module is referred to. This way
+you can have different implementations or versions of the same module
+and switch them out.
+An example of this is the module "serversetup-bwlp" which is symlinked
+as just "serversetup", so we can have "serversetup-cdn" in the future,
+as it seems the two locations have quite different requirements for this
+module's functionality.
+
+Note that a module identifier cannot contain dashes (-), so this is an
+easy way to hint that a module is supposed to be aliased when being
+activated.
-- 
cgit v1.2.3-55-g7522