From 56594dd5df01b717adf5ce8f100077041ff4a275 Mon Sep 17 00:00:00 2001 From: Darryl Norris Date: Wed, 3 Jun 2015 14:33:40 -0500 Subject: [PATCH] Improving README.txt files in D7 --- profiles/README.txt | 28 ++++++++++++++++++++++++++++ sites/all/libraries/README.txt | 24 ++++++++++++++++++++++++ sites/all/modules/README.txt | 40 ++++++++++++++++++++++++++++++---------- sites/all/themes/README.txt | 37 ++++++++++++++++++++++++++----------- 4 files changed, 108 insertions(+), 21 deletions(-) create mode 100644 profiles/README.txt diff --git a/profiles/README.txt b/profiles/README.txt new file mode 100644 index 0000000..91d012b --- /dev/null +++ b/profiles/README.txt @@ -0,0 +1,28 @@ +Installation profiles define additional steps that run after the base +installation provided by Drupal core when Drupal is first installed. + +WHAT TO PLACE IN THIS DIRECTORY? +-------------------------------- + +Place downloaded and custom installation profiles in this directory. +Installation profiles are generally provided as part of a Drupal distribution. +They only impact the installation of your site. They do not have any effect on +an already running site. + +DOWNLOAD ADDITIONAL DISTRIBUTIONS +--------------------------------- + +Contributed distributions from the Drupal community may be downloaded at +https://www.drupal.org/project/project_distribution. + +MULTISITE CONFIGURATION +----------------------- + +In multisite configurations, installation profiles found in this directory are +available to all sites during their initial site installation. + +MORE INFORMATION +---------------- + +Refer to the "Installation profiles" section of the README.txt in the Drupal +root directory for further information on extending Drupal with custom profiles. diff --git a/sites/all/libraries/README.txt b/sites/all/libraries/README.txt index de5d585..76488aa 100644 --- a/sites/all/libraries/README.txt +++ b/sites/all/libraries/README.txt @@ -1,2 +1,26 @@ This directory should be used to place downloaded and custom libraries (such as JavaScript libraries) which are used by contributed or custom modules. + +WHAT TO PLACE IN THIS DIRECTORY? +-------------------------------- + +Placing downloaded and custom libraries in this directory separates downloaded +and custom libraries from Drupal core's libraries. This allows Drupal core to be +updated without overwriting these files. + +DOWNLOAD ADDITIONAL LIBRARIES +------------------------------ + +? + +MULTISITE CONFIGURATION +----------------------- + +In multisite configurations, libraries found in this directory are available to +all sites. Alternatively, the sites/your_site_name/libraries +directory pattern may be used to restrict libraries to a specific site instance. + +MORE INFORMATION +---------------- + +? diff --git a/sites/all/modules/README.txt b/sites/all/modules/README.txt index c72b43e..2b70b48 100644 --- a/sites/all/modules/README.txt +++ b/sites/all/modules/README.txt @@ -1,16 +1,36 @@ -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. +Modules extend your site functionality beyond Drupal core. -It is safe to organize modules into subdirectories, such as "contrib" for +WHAT TO PLACE IN THIS DIRECTORY? +-------------------------------- + +Placing downloaded and custom modules in this directory separates downloaded and +custom modules from Drupal core's modules. This allows Drupal core to be updated +without overwriting these files. + +DOWNLOAD ADDITIONAL MODULES +--------------------------- + +Contributed modules from the Drupal community may be downloaded at +https://www.drupal.org/project/project_module. + +ORGANIZING MODULES IN THIS DIRECTORY +------------------------------------ + +You may create subdirectories in this directory, to organize your added modules, +without breaking the site. Some common subdirectories include "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. +Drupal cache so it can be found. + +MULTISITE CONFIGURATION +----------------------- + +In multisite configurations, 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. -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. +MORE INFORMATION +---------------- -Refer to the "Developing for Drupal" section of the README.txt in the Drupal +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 e308af2..5399f5e 100644 --- a/sites/all/themes/README.txt +++ b/sites/all/themes/README.txt @@ -1,14 +1,29 @@ -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. +Themes allow you to change the look and feel of your Drupal site. You can use +themes contributed by others or create your own. -It is safe to organize themes into subdirectories and is recommended to use -Drupal's sub-theme functionality to ensure easy maintenance and upgrades. +WHAT TO PLACE IN THIS DIRECTORY? +-------------------------------- -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. +Placing downloaded and custom themes in this directory separates downloaded and +custom themes from Drupal core's themes. This allows Drupal core to be updated +without overwriting these files. -Refer to the "Appearance" section of the README.txt in the Drupal root -directory for further information on theming. +DOWNLOAD ADDITIONAL THEMES +-------------------------- + +Contributed themes from the Drupal community may be downloaded at +https://www.drupal.org/project/project_theme. + +MULTISITE CONFIGURATION +----------------------- + +In multisite configurations, 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. + +MORE INFORMATION +----------------- + +Refer to the "Appearance" section of the README.txt in the Drupal root directory +for further information on customizing the appearance of Drupal with custom +themes. -- 2.3.2 (Apple Git-55)