From d5d61ddce21f0763a8af275e2d675bfd0c1c7ba7 Mon Sep 17 00:00:00 2001 From: Darryl Norris Date: Tue, 12 May 2015 14:16:57 -0700 Subject: [PATCH] #1539940: Improving the README.txt for sites/all/modules/README.txt , sites/all/themes/README.txt , profiles/README.txt --- profiles/README.txt | 32 ++++++++++++++++++++++++++ sites/all/modules/README.txt | 53 +++++++++++++++++++++++++++++++------------- sites/all/themes/README.txt | 39 +++++++++++++++++++++++++------- 3 files changed, 100 insertions(+), 24 deletions(-) create mode 100644 profiles/README.txt diff --git a/profiles/README.txt b/profiles/README.txt new file mode 100644 index 0000000..c3fefdf --- /dev/null +++ b/profiles/README.txt @@ -0,0 +1,32 @@ +Installation profiles define additional steps that run after the base +installation provided by core when Drupal is first installed. There are two +basic installation profiles provided with Drupal core. + +WHAT TO PLACE IN THIS DIRECTORY? +-------------------------------- + +Place downloaded and custom installation profiles in this directory to ensure +these installation profile remain separate from Drupal Core's. Installation +profiles which allows Drupal Core to be updated without overwriting these files. + +DOWNLOAD CONTRIBUTED PROFILES +---------------------------- + +Contributed profiles 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. Shared common +profiles may also be kept in the sites/all/profiles directory and will take +precedence over profiles in this directory. Alternatively, the +sites/your_site_name/profiles directory pattern may be used to restrict a +profile's availability to a specific site instance. + +MORE INFORMATION +---------------- + +Refer to the "Installation profiles" section of the README.txt in Drupal root +directory for further information on extending Drupal with custom profiles. diff --git a/sites/all/modules/README.txt b/sites/all/modules/README.txt index c72b43e..ef5e3c5 100644 --- a/sites/all/modules/README.txt +++ b/sites/all/modules/README.txt @@ -1,16 +1,37 @@ -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. - -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. +Modules extend your site functionality beyond Drupal Core. + +WHAT TO PLACE IN THIS DIRECTORY? +-------------------------------- + +Place downloaded and custom modules in this directory. This ensures these +modules remain separate from Drupal Core's modules which allows Drupal Core +to be updated without overwriting these files. + +DOWNLOAD ADDITIONAL MODULES +--------------------------- + +Contributed modules from the Drupal Community may be downloaded at +http://drupal.org/project/modules. + +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 +"custom" for contrib 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 it can be found. + +MULTISITE CONFIGURATION +----------------------- + +In multisite configurations, modules found in this directory are available to +all sites. You may also put modules in the sites/all/modules directory, and the +versions in sites/all/modules will take precedence over versions of the same +module that are here. + +MORE INFORMATION +---------------- + +Refer to the “Developing for Drupal” section of the README.txt in 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..965b2aa 100644 --- a/sites/all/themes/README.txt +++ b/sites/all/themes/README.txt @@ -1,14 +1,37 @@ -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. + +WHAT TO PLACE IN THIS DIRECTORY? +-------------------------------- + +Place downloaded and custom themes in this directory to ensures these +themes remain separate from Drupal Core's themes which allows Drupal Core to +be updated without overwriting these files. + +SUB-THEME +--------- It is safe to organize themes into subdirectories and is recommended to use Drupal's sub-theme functionality to ensure easy maintenance and upgrades. +For more information about sub-themes https://www.drupal.org/node/225125 + + +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. You may also put themes in the sites/all/themes directory, and the +versions in sites/all/themes will take precedence over versions of the same +themes that are here. -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. +MORE INFORMATION +----------------- Refer to the "Appearance" section of the README.txt in the Drupal root -directory for further information on theming. +directory for further information on extending Drupal with custom themes. -- 1.9.1