You are here

Home » API reference » Config Partial Export 8

README.txt in Config Partial Export 8 

CONTENTS OF THIS FILE
---------------------
 * Introduction
 * Requirements
 * Installation
 * Configuration
 * How to use
 * Full synchronisation
 * Maintainers


INTRODUCTION
------------
This module is for developers when on dev site one would like to export only
the modified config files shown in
Configuration > configuration management > Synchronize
(/admin/config/development/configuration) tab.

 * For a full description of the module, visit the project page:
   https://www.drupal.org/project/config_partial_export

 * To submit bug reports and feature suggestions, or to track changes:
   https://www.drupal.org/project/issues/config_partial_export?categories=All


REQUIREMENTS
------------
No special requirements.


INSTALLATION
------------
Before you install the module it's advised to do a full synch of your
configuration otherwise all your config files will be listed by this module.
For more details see Full synchronisation part of this document.

 * Install as you would normally install a contributed Drupal module. See:
   https://www.drupal.org/docs/8/extending-drupal-8/installing-drupal-8-modules
   for further information.


CONFIGURATION
-------------
The module has no menu or modifiable settings. There is no configuration. When
enabled a 'Partial config' tab will appear on
admin/config/development/configuration page.


HOW TO USE
----------------
After enabling a 'Partial config' tab will appear on
admin/config/development/configuration page. Click on the Partial Export tab
and select the files you want to export to a tarball. In addition you can add
to the list the system.site.yml file which holds the UUID of your site.
After export you can copy the files from the tarball to your config/install
folder to apply those changes on next install.


FULL SYNCHRONISATION
--------------------
Steps to do a full synch:
 * Do a full export then an import. Your config files will be copied then to the
   staging directory (by default: sites/default/files/config_some-hash/staging).
 * Do a small modification in your settings. The files related with this
   modification will be listed on admin/config/development/configuration page.
 * Click "Import all" button. Be aware, all modifications you have done since
   last import will be lost!


MAINTAINERS
-----------
Original author:
 * László Kovács - https://www.drupal.org/u/laszlo.kovacs
Current maintainer:
 * Balu Ertl - https://www.drupal.org/u/balu-ertl

This project has been sponsored by:
 * Cheppers Ltd.
   A team of experienced web developers working with the Drupal content
   management system. Expertised in Drupal consulting, development, professional
   website design, search engine optimization (SEO), e-commerce and data
   migration. Visit https://cheppers.com/ for more information.

File

README.txt
View source 
  1. CONTENTS OF THIS FILE

  2. ---------------------

  3.  * Introduction

  4.  * Requirements

  5.  * Installation

  6.  * Configuration

  7.  * How to use

  8.  * Full synchronisation

  9.  * Maintainers

  10. 

  11. 

  12. INTRODUCTION

  13. ------------

  14. This module is for developers when on dev site one would like to export only

  15. the modified config files shown in

  16. Configuration > configuration management > Synchronize

  17. (/admin/config/development/configuration) tab.

  18. 

  19.  * For a full description of the module, visit the project page:

  20.    https://www.drupal.org/project/config_partial_export

  21. 

  22.  * To submit bug reports and feature suggestions, or to track changes:

  23.    https://www.drupal.org/project/issues/config_partial_export?categories=All

  24. 

  25. 

  26. REQUIREMENTS

  27. ------------

  28. No special requirements.

  29. 

  30. 

  31. INSTALLATION

  32. ------------

  33. Before you install the module it's advised to do a full synch of your

  34. configuration otherwise all your config files will be listed by this module.

  35. For more details see Full synchronisation part of this document.

  36. 

  37.  * Install as you would normally install a contributed Drupal module. See:

  38.    https://www.drupal.org/docs/8/extending-drupal-8/installing-drupal-8-modules

  39.    for further information.

  40. 

  41. 

  42. CONFIGURATION

  43. -------------

  44. The module has no menu or modifiable settings. There is no configuration. When

  45. enabled a 'Partial config' tab will appear on

  46. admin/config/development/configuration page.

  47. 

  48. 

  49. HOW TO USE

  50. ----------------

  51. After enabling a 'Partial config' tab will appear on

  52. admin/config/development/configuration page. Click on the Partial Export tab

  53. and select the files you want to export to a tarball. In addition you can add

  54. to the list the system.site.yml file which holds the UUID of your site.

  55. After export you can copy the files from the tarball to your config/install

  56. folder to apply those changes on next install.

  57. 

  58. 

  59. FULL SYNCHRONISATION

  60. --------------------

  61. Steps to do a full synch:

  62.  * Do a full export then an import. Your config files will be copied then to the

  63.    staging directory (by default: sites/default/files/config_some-hash/staging).

  64.  * Do a small modification in your settings. The files related with this

  65.    modification will be listed on admin/config/development/configuration page.

  66.  * Click "Import all" button. Be aware, all modifications you have done since

  67.    last import will be lost!

  68. 

  69. 

  70. MAINTAINERS

  71. -----------

  72. Original author:

  73.  * László Kovács - https://www.drupal.org/u/laszlo.kovacs

  74. Current maintainer:

  75.  * Balu Ertl - https://www.drupal.org/u/balu-ertl

  76. 

  77. This project has been sponsored by:

  78.  * Cheppers Ltd.

  79.    A team of experienced web developers working with the Drupal content

  80.    management system. Expertised in Drupal consulting, development, professional

  81.    website design, search engine optimization (SEO), e-commerce and data

  82.    migration. Visit https://cheppers.com/ for more information.