diff options
| -rw-r--r-- | README.txt | 35 | ||||
| -rw-r--r-- | sites/README.txt | 19 | ||||
| -rw-r--r-- | sites/all/README.txt | 7 | ||||
| -rw-r--r-- | sites/all/modules/README.txt | 18 | ||||
| -rw-r--r-- | sites/all/themes/README.txt | 16 |
5 files changed, 82 insertions, 13 deletions
diff --git a/README.txt b/README.txt index 921f99c64..f4c2f643a 100644 --- a/README.txt +++ b/README.txt @@ -4,6 +4,7 @@ CONTENTS OF THIS FILE * About Drupal * Configuration and features + * Installation profiles * Appearance * Developing for Drupal @@ -43,6 +44,40 @@ More about configuration: http://drupal.org/project/modules * See also: "Developing for Drupal" for writing your own modules, below. +INSTALLATION PROFILES +--------------------- + +Installation profiles define additional steps (such as enabling modules, +defining content types, etc.) that run after the base installation provided +by core when Drupal is first installed. There are two basic installation +profiles provided with Drupal core. + +Installation profiles from the Drupal community modify the installation process +to provide a website for a specific use case, such as a CMS for media +publishers, a web-based project tracking tool, or a full-fledged CRM for +non-profit organizations raising money and accepting donations. They can be +distributed as bare installation profiles or as "distributions". Distributions +include Drupal core, the installation profile, and all other required +extensions, such as contributed and custom modules, themes, and third-party +libraries. Bare installation profiles require you to download Drupal Core and +the required extensions separately; place the downloaded profile in the +/profiles directory before you start the installation process. Note that the +contents of this directory may be overwritten during updates of Drupal core; +it is advised to keep code backups or use a version control system. + +Additionally, modules and themes may be placed inside subdirectories in a +specific installation profile such as profiles/your_site_profile/modules and +profiles/your_site_profile/themes respectively to restrict their usage to only +sites that were installed with that specific profile. + +More about installation profiles and distributions: +* Read about the difference between installation profiles and distributions: + http://drupal.org/node/1089736 +* Download contributed installation profiles and distributions: + http://drupal.org/project/distributions +* Develop your own installation profile or distribution: + http://drupal.org/developing/distributions + APPEARANCE ---------- diff --git a/sites/README.txt b/sites/README.txt new file mode 100644 index 000000000..9aecef2d7 --- /dev/null +++ b/sites/README.txt @@ -0,0 +1,19 @@ +This directory structure contains the settings and configuration files specific +to your site or sites and is an integral part of multisite configuration. + +The sites/all/ subdirectory structure should be used to place your custom and +downloaded extensions including modules, themes, and third party libraries. + +Downloaded installation profiles should be placed in the /profiles directory +in the Drupal root. + +In multisite configuration, extensions found in the sites/all directory +structure are available to all sites. Alternatively, the sites/your_site_name/ +subdirectory pattern may be used to restrict extensions to a specific +site instance. + +See the respective README.txt files in sites/all/themes and sites/all/modules +for additional information about obtaining and organizing extensions. + +See INSTALL.txt in the Drupal root for information about single-site +installation or multisite configuration. diff --git a/sites/all/README.txt b/sites/all/README.txt deleted file mode 100644 index c8970883a..000000000 --- a/sites/all/README.txt +++ /dev/null @@ -1,7 +0,0 @@ - -This directory should be used to place downloaded and custom modules -and themes which are common to all sites. Keeping contributed and -custom modules and themes in the sites directory will aid in upgrading -Drupal core files. Place contributed and custom modules and themes in -the sites/all/modules and sites/all/themes directories respectively. - diff --git a/sites/all/modules/README.txt b/sites/all/modules/README.txt index f4e35b558..c72b43e4f 100644 --- a/sites/all/modules/README.txt +++ b/sites/all/modules/README.txt @@ -1,4 +1,16 @@ +Place downloaded and custom modules that extend your site functionality beyond +Drupal core in this directory to ensure clean separation from core modules and +to facilitate safe, self-contained code updates. Contributed modules from the +Drupal community may be downloaded at http://drupal.org/project/modules. -This directory should be used to place downloaded and custom modules -which are common to all sites. This will allow you to more easily -update Drupal core files. +It is safe to organize modules into subdirectories, such as "contrib" for +contributed modules, and "custom" for custom modules. Note that if you move a +module to a subdirectory after it has been enabled, you may need to clear the +Drupal cache so that it can be found. + +In multisite configuration, modules found in this directory are available to +all sites. Alternatively, the sites/your_site_name/modules directory pattern may +be used to restrict modules to a specific site instance. + +Refer to the "Developing for Drupal" section of the README.txt in the Drupal +root directory for further information on extending Drupal with custom modules. diff --git a/sites/all/themes/README.txt b/sites/all/themes/README.txt index e9425214b..e308af205 100644 --- a/sites/all/themes/README.txt +++ b/sites/all/themes/README.txt @@ -1,4 +1,14 @@ +Place downloaded and custom themes that modify your site's appearance in this +directory to ensure clean separation from Drupal core and to facilitate safe, +self-contained code updates. Contributed themes from the Drupal community may +be downloaded at http://drupal.org/project/themes. -This directory should be used to place downloaded and custom themes -which are common to all sites. This will allow you to more easily -update Drupal core files. +It is safe to organize themes into subdirectories and is recommended to use +Drupal's sub-theme functionality to ensure easy maintenance and upgrades. + +In multisite configuration, themes found in this directory are available to +all sites. Alternatively, the sites/your_site_name/themes directory pattern may +be used to restrict themes to a specific site instance. + +Refer to the "Appearance" section of the README.txt in the Drupal root +directory for further information on theming. |