Skip to content

Commit

Permalink
Issue #2115737 by darol100, owenpm3, rhuffstedtler, andythomnz, jeman…
Browse files Browse the repository at this point in the history
…dy, ijf8090, zealfire, er.pushpinderrana, jhodgdon, corbacho, spitcher, abenamer, holingpoon, ay1n: Make the text in modules, themes, and profiles README.txt files more user-friendly
  • Loading branch information
DavidRothstein committed Oct 14, 2015
1 parent d2dd30f commit 8b0f1c7
Show file tree
Hide file tree
Showing 3 changed files with 84 additions and 21 deletions.
28 changes: 28 additions & 0 deletions 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.
40 changes: 30 additions & 10 deletions sites/all/modules/README.txt
@@ -1,17 +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.
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. (Alternatively, you can disable the
module before moving it and then re-enable it after the move.)
Drupal cache so it can be found. (Alternatively, you can disable the module
before moving it and then re-enable it after the move.)

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
root directory for further information on extending Drupal with custom modules.
37 changes: 26 additions & 11 deletions 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.

0 comments on commit 8b0f1c7

Please sign in to comment.