From 77e75d6293c6489899bfff163663d67e56b4ea80 Mon Sep 17 00:00:00 2001 From: Alex Pott Date: Wed, 23 Dec 2020 08:33:36 +0000 Subject: [PATCH] Issue #3095734 by Amber Himes Matz, jhodgdon, abhisekmazumdar, VladimirAus, sarvjeetsingh, Ramya Balasubramanian, saurabh-2k17, pradeepjha, naresh_bavaskar, pratik_kamble, alexpott: Convert config module hook_help() to topic(s) --- .../help_topics/config.export_full.html.twig | 17 +++++++ .../config.export_single.html.twig | 20 ++++++++ .../help_topics/config.import_full.html.twig | 20 ++++++++ .../config.import_single.html.twig | 21 ++++++++ .../core.config_overview.html.twig | 50 +++++++++++++++++++ 5 files changed, 128 insertions(+) create mode 100644 core/modules/help_topics/help_topics/config.export_full.html.twig create mode 100644 core/modules/help_topics/help_topics/config.export_single.html.twig create mode 100644 core/modules/help_topics/help_topics/config.import_full.html.twig create mode 100644 core/modules/help_topics/help_topics/config.import_single.html.twig create mode 100644 core/modules/help_topics/help_topics/core.config_overview.html.twig diff --git a/core/modules/help_topics/help_topics/config.export_full.html.twig b/core/modules/help_topics/help_topics/config.export_full.html.twig new file mode 100644 index 00000000000..03213128e17 --- /dev/null +++ b/core/modules/help_topics/help_topics/config.export_full.html.twig @@ -0,0 +1,17 @@ +--- +label: 'Exporting your complete site configuration' +related: +- core.config_overview +- config.import_full +- config.export_single +- config.import_single +--- +{% set export = render_var(url('config.export_full')) %} +{% set config_overview = render_var(url('help.help_topic', {'id': 'core.config_overview'})) %} +

{% trans %}Goal{% endtrans %}

+

{% trans %}Create and download an archive containing all your site's configuration, exported as YAML files. See Managing and deploying configuration for more information about configuration.{% endtrans %}

+

{% trans %}Steps{% endtrans %}

+
    +
  1. {% trans %}In the Manage administrative menu, navigate to Configuration > Development > Configuration synchronization > Export.{% endtrans %}
    2. +
  2. {% trans %}Click Export and save the archive file.{% endtrans %}
    3. +
diff --git a/core/modules/help_topics/help_topics/config.export_single.html.twig b/core/modules/help_topics/help_topics/config.export_single.html.twig new file mode 100644 index 00000000000..8a1cf57f3b2 --- /dev/null +++ b/core/modules/help_topics/help_topics/config.export_single.html.twig @@ -0,0 +1,20 @@ +--- +label: 'Exporting a single configuration item' +related: +- core.config_overview +- config.export_full +- config.import_full +- config.import_single +--- +{% set single_export = render_var(url('config.export_single')) %} +{% set config_overview = render_var(url('help.help_topic', {'id': 'core.config_overview'})) %} +

{% trans %}Goal{% endtrans %}

+

{% trans %}Export a single configuration item to a file. See Managing and deploying configuration for more information about configuration.{% endtrans %}

+

{% trans %}Steps{% endtrans %}

+
    +
  1. {% trans %}In the Manage administrative menu, navigate to Configuration > Development > Configuration synchronization > Export > Single item.{% endtrans %}
    2. +
  2. {% trans %}Select the Configuration type that you want to export, and then select the specific Configuration name to export.{% endtrans %}
    3. +
  3. {% trans %}Use your browser to copy the text in the box marked Here is your configuration to the clipboard.{% endtrans %}
    4. +
  4. {% trans %}Paste the copied text into a plain-text editor on your computer or other device, and save it using the suggested file name below the text box.{% endtrans %} +
    5. +
diff --git a/core/modules/help_topics/help_topics/config.import_full.html.twig b/core/modules/help_topics/help_topics/config.import_full.html.twig new file mode 100644 index 00000000000..a083d79dd2b --- /dev/null +++ b/core/modules/help_topics/help_topics/config.import_full.html.twig @@ -0,0 +1,20 @@ +--- +label: 'Importing your complete site configuration' +related: +- core.config_overview +- config.export_full +- config.import_single +- config.export_single +--- +{% set import_page = render_var(url('config.import_full')) %} +{% set export_full = render_var(url('help.help_topic', {'id': 'config.export_full'})) %} +{% set config_overview = render_var(url('help.help_topic', {'id': 'core.config_overview'})) %} +

{% trans %}Goal{% endtrans %}

+

{% trans %}Import the complete configuration of your site from an archive file, such as one that was previously exported (see Exporting your complete site configuration). See Managing and deploying configuration for more information about configuration.{% endtrans %}

+

{% trans %}Steps{% endtrans %}

+
    +
  1. {% trans %}In the Manage administrative menu, navigate to Configuration > Development > Configuration synchronization > Import.{% endtrans %}
    2. +
  2. {% trans %}Browse to find the Configuration archive that you want to import.{% endtrans %}
    3. +
  3. {% trans %}Click Upload. Your configuration archive will be unpacked and placed in the configuration synchronization directory, and you will be redirected to the Synchronize page.{% endtrans %}
    4. +
  4. {% trans %}Review the differences between your uploaded configuration and the active configuration, if any, and click Import all to import the changes.{% endtrans %}
    5. +
diff --git a/core/modules/help_topics/help_topics/config.import_single.html.twig b/core/modules/help_topics/help_topics/config.import_single.html.twig new file mode 100644 index 00000000000..c1e40fe58d7 --- /dev/null +++ b/core/modules/help_topics/help_topics/config.import_single.html.twig @@ -0,0 +1,21 @@ +--- +label: 'Importing a single configuration item' +related: +- core.config_overview +- config.export_full +- config.import_full +- config.export_single +--- +{% set single_import = render_var(url('config.import_single')) %} +{% set single_export = render_var(url('help.help_topic', {'id': 'config.export_single'})) %} +{% set config_overview = render_var(url('help.help_topic', {'id': 'core.config_overview'})) %} +

{% trans %}Goal{% endtrans %}

+

{% trans %}Import a single configuration item in YAML format, such as one that was previously exported (see Exporting a single configuration item). See Managing and deploying configuration for more information about configuration.{% endtrans %}

+

{% trans %}Steps{% endtrans %}

+
    +
  1. {% trans %}In the Manage administrative menu, navigate to Configuration > Development > Configuration synchronization > Import > Single item.{% endtrans %}
    2. +
  2. {% trans %}Select the Configuration type that you want to import.{% endtrans %}
    3. +
  3. {% trans %}On your computer or other device, copy the YAML-format configuration that you want to import to the clipboard.{% endtrans %}
    4. +
  4. {% trans %}Paste the clipboard text into the box labeled Paste your configuration here.{% endtrans %}
    5. +
  5. {% trans %}Click Import.{% endtrans %}
    6. +
diff --git a/core/modules/help_topics/help_topics/core.config_overview.html.twig b/core/modules/help_topics/help_topics/core.config_overview.html.twig new file mode 100644 index 00000000000..952ca6060b4 --- /dev/null +++ b/core/modules/help_topics/help_topics/core.config_overview.html.twig @@ -0,0 +1,50 @@ +--- +label: 'Managing and deploying configuration' +top_level: true +related: +- config.export_full +- config.import_full +- config.export_single +- config.import_single +--- +

{% trans %}What is the configuration system?{% endtrans %}

+

{% trans %}The configuration system provides the ability for administrators to customize the site, and to move and synchronize configuration changes between development sites and the live site. It does this in 2 ways:{% endtrans %}

+
    +
  1. {% trans %}Providing storage for configuration{% endtrans %}
    2. +
  2. {% trans %}Providing a process in which configuration changes can be imported and exported between instances of the same site; for example, from "dev" to "staging" to "live"{% endtrans %}
    3. +
+

{% trans %}What is configuration data?{% endtrans %}

+

{% trans %}Configuration data describes settings that define how your site behaves or is displayed. For example, when a site administrator updates settings using an administrative form, these settings are stored as configuration data. Configuration data describes settings as simple as a site name and as complex as a view or image style.{% endtrans %}

+

{% trans %}What kinds of configuration are there?{% endtrans %}

+
+
{% trans %}Active configuration{% endtrans %}
+
{% trans %}Active configuration is the current working configuration of a site. Storage of active configuration is defined by the site, and resides in the database by default.{% endtrans %}
+
{% trans %}Simple configuration{% endtrans %}
+
{% trans %}A simple configuration item is a group of settings, such as the settings for a module or theme. Each simple configuration item has its own unique structure.{% endtrans %}
+
{% trans %}Configuration entities{% endtrans %}
+
{% trans %}Configuration entities are user-defined configuration items grouped by type, such as views, image styles, and content types. Each configuration entity within a type has a similar structure.{% endtrans %}
+
{% trans %}Default configuration{% endtrans %}
+
{% trans %}Default configuration can be defined by a module, theme, or installation profile in its config/install or config/optional directories. Configuration is provided in YAML files (file extension .yml); YAML is a human-readable data serialization standard that is used by the core software for several purposes. Once the default configuration has been imported into the site's active configuration (through installing the extension), that configuration is owned by the site, not the extension. This means that future updates of the extension will not override the site's active configuration for that extension.{% endtrans %}
+
+

{% trans %}What is configuration synchronization?{% endtrans %}

+

{% trans %}Configuration synchronization is the process of exporting and importing configuration to keep configuration synchronized between different versions of a site; for example, between a development site and the live site.{% endtrans %}

+

{% trans %}Each site has unique identifier, also called a UUID, which identifies the site to the system in any instance of the site, as long as the site instances have been reproduced as clones (cloning is when the codebase and database are copied to create a new site instance). When site instances are cloned, a "dev" instance of the site has the same UUID as the "live" instance. When site instances share the same UUID, configuration can be exported from one instance to another.{% endtrans %}

+

{% trans %}The following list contains terms and concepts related to configuration synchronization:{% endtrans %}

+
+
{% trans %}Exported configuration{% endtrans %}
+
{% trans %}When configuration is exported, the active configuration is exported as a set of files in YAML format. When using the Configuration synchronization administrative UI, configuration can be exported as a full-export or single-item archive. This archive can then be imported into the destination site instance.{% endtrans %}
+
{% trans %}Imported configuration{% endtrans %}
+
{% trans %}Imported configuration is configuration that has been exported from another instance of the site (the "source") and is now being imported into another site instance (the "destination"), thereby updating its active configuration to match the imported configuration data set.{% endtrans %}
+
{% trans %}Configuration sync directory{% endtrans %}
+
{% trans %}The configuration sync directory location is set in the site's settings.php file. When configuration is exported, the active configuration is exported and described in YAML files which are stored in the configuration sync directory. After the first export, the system compares the site's active configuration with the configuration data in the sync directory and will only export active configuration items that are different than their counterparts in the sync directory.{% endtrans %}
+
+

{% trans %}Managing configuration overview{% endtrans %}

+

{% trans %}Configuration management tasks, such as exporting or importing configuration and synchronizing configuration, can be done either through the administrative UI provided by the core Configuration Manager module or a command-line interface (CLI) tool. Defining a configuration sync directory path other than the default value requires read/write access to the site's settings.php file.{% endtrans %}

+

{% trans %}Most modules and themes also provide settings forms for updating the configuration they provide. See the related topics listed below for specific tasks.{% endtrans %}

+

{% trans %}Additional resources{% endtrans %}

+