diff options
| author | Simon Rettberg | 2016-06-14 17:13:54 +0200 |
|---|---|---|
| committer | Simon Rettberg | 2016-06-14 17:13:54 +0200 |
| commit | 1873fa94f309b4acc2c16eea2b26387d540ae55f (patch) | |
| tree | 028db06f4a61bf8432d615cd4c965295967227d5 /doc/enabling_modules | |
| parent | [citymanagement] Create new menu categories in cities module (mostly as an ex... (diff) | |
| download | slx-admin-1873fa94f309b4acc2c16eea2b26387d540ae55f.tar.gz slx-admin-1873fa94f309b4acc2c16eea2b26387d540ae55f.tar.xz slx-admin-1873fa94f309b4acc2c16eea2b26387d540ae55f.zip | |
Add documentation
Diffstat (limited to 'doc/enabling_modules')
| -rw-r--r-- | doc/enabling_modules | 16 |
1 files changed, 16 insertions, 0 deletions
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. |