You are here

README.txt in Configuration Management 7

Same filename and directory in other branches
  1. 7.2 README.txt
CONTENTS OF THIS FILE
---------------------

 * Introduction
 * Installation
 * Definitions
 * Usage
 * Design Decisions


INTRODUCTION
------------

The configuration management module enables the ability to keep track of
specific configurations on a Drupal site, provides the ability to move these
configurations between different environments (local, dev, qa, prod), and also
move configurations between completely different sites (migrate configurations)

This module is a rewrite of the features module without the features part of it.
The module also uses some concepts from the configuration management initiative,
specifically the concept of the "activestore" and "datastore" architecture.

The configuration module isn't a replacement for features. The vision is that 
they could work together. Features currently serves two purposes, 1) to group
configuration together to satisfy a certain use-case, and 2) the actual export
and management of configuration into a "feature" module. Features module is an
awesome module when using it for what it was built for, creating KIT compliant
features. The reality is most people that use features probably haven't even
read the KIT specification.


INSTALLATION
------------

After downloading the configuration module and uncompressing it, copy the whole 
configuration directory to your modules directory and activate the module.

DEFINITIONS
-----------
                                   
 * activestore
   
   The activestore is where configuration is read from by Drupal. The
   configuration module imports all exportables into the database.  All
   exportables effectively become faux-exportables, configuration is not read 
   from exported code.
   
 * datastore
 
   The datastore is configuration data stored on-disk using ctools exportable 
   files and configuration api exports.  This configuration is not read and
   accessed by Drupal for page construction. Configuration from the datastore
   is activated (imported) into the activestore. Drupal accesses configuration
   from the activestore.
   
 * config.export
 
   Documentation needs to be written.
 
 * migration
 
   Documentation needs to be written.
  

USAGE
-----

 * Tracking configuration
 
   Add documentation on how to track configuration.
 
 * Un-tracking configuration
 
   Add documentation on how to stop tracking configuration.
 
 * Migrate configuration to another site.
 
   Add documentation on how to migrate to another site.
 
 * General settings
 
   Describe what each setting does.


DESIGN DECISIONS
----------------

File

README.txt
View source
  1. CONTENTS OF THIS FILE
  2. ---------------------
  3. * Introduction
  4. * Installation
  5. * Definitions
  6. * Usage
  7. * Design Decisions
  8. INTRODUCTION
  9. ------------
  10. The configuration management module enables the ability to keep track of
  11. specific configurations on a Drupal site, provides the ability to move these
  12. configurations between different environments (local, dev, qa, prod), and also
  13. move configurations between completely different sites (migrate configurations)
  14. This module is a rewrite of the features module without the features part of it.
  15. The module also uses some concepts from the configuration management initiative,
  16. specifically the concept of the "activestore" and "datastore" architecture.
  17. The configuration module isn't a replacement for features. The vision is that
  18. they could work together. Features currently serves two purposes, 1) to group
  19. configuration together to satisfy a certain use-case, and 2) the actual export
  20. and management of configuration into a "feature" module. Features module is an
  21. awesome module when using it for what it was built for, creating KIT compliant
  22. features. The reality is most people that use features probably haven't even
  23. read the KIT specification.
  24. INSTALLATION
  25. ------------
  26. After downloading the configuration module and uncompressing it, copy the whole
  27. configuration directory to your modules directory and activate the module.
  28. DEFINITIONS
  29. -----------
  30. * activestore
  31. The activestore is where configuration is read from by Drupal. The
  32. configuration module imports all exportables into the database. All
  33. exportables effectively become faux-exportables, configuration is not read
  34. from exported code.
  35. * datastore
  36. The datastore is configuration data stored on-disk using ctools exportable
  37. files and configuration api exports. This configuration is not read and
  38. accessed by Drupal for page construction. Configuration from the datastore
  39. is activated (imported) into the activestore. Drupal accesses configuration
  40. from the activestore.
  41. * config.export
  42. Documentation needs to be written.
  43. * migration
  44. Documentation needs to be written.
  45. USAGE
  46. -----
  47. * Tracking configuration
  48. Add documentation on how to track configuration.
  49. * Un-tracking configuration
  50. Add documentation on how to stop tracking configuration.
  51. * Migrate configuration to another site.
  52. Add documentation on how to migrate to another site.
  53. * General settings
  54. Describe what each setting does.
  55. DESIGN DECISIONS
  56. ----------------