Relocated custom folders to a friendlier customization folder with appropriate readme

alliance_auth/settings.py.example

@@ -122,12 +122,12 @@ TEMPLATE_CONTEXT_PROCESSORS = (
 )
 
 TEMPLATE_DIRS = (
-    'custom_templates',
+    'customization/templates',
     'templates',
 )
 
 STATICFILES_DIRS = (
-    'custom_static',
+    'customization/static',
     'static',
 )
 

customization/README.md

@@ -0,0 +1,7 @@
+If you want to customize your site, place the custom files in the appropriate directories below.
+
+Place custom pages in the templates directory.
+
+Place custom images, css, etc in the static directory.
+
+Be sure to make folders are required to preserve the original file location.

customization/static/.gitignore

@@ -0,0 +1,5 @@
+# Ignore everything in this directory
+*
+# Except this file
+!.gitignore
+!README.md

customization/static/README.md

@@ -0,0 +1,7 @@
+Place your custom static files in this folder. Maintain the folder structure of the original static folder. 
+
+For instance, if you have a custom background image for the index page, it would be located at:
+
+`customization/static/img/index_images/index_blank_bg.jpg`
+
+This directory will get searched first for the image, then fall back to the default.

customization/templates/.gitignore

@@ -0,0 +1,5 @@
+#Ignore everything in this directory
+*
+# Except this file
+!.gitignore
+!README.md

customization/templates/README.md

@@ -0,0 +1,7 @@
+Place your custom templates in this folder.
+Maintain the folder structure of the original templates folder.
+For instance, if you have a custom index page, it would be located at:
+
+`customization/templates/public/index.html`
+
+This directory will get searched first, then fall back to the defaults.