Add help topic about installing site from configuration

Created on 22 June 2023, over 1 year ago

Problem/Motivation

In 📌 Fix up minor copy problems in help topics Fixed , there is this item:

  • core.config_overview.html.twig -- alexpott wrote on #3095734-102: Convert config module hook_help() to topic(s) (slightly edited for clarity): We need to add information about installing from configuration, as the part on cloning could encompass this. If people knew about and used installing from configuration more often then people wouldn't think so much about the site UUID.
  • Which is part of a host of other minor issues with help topics. Moving this task to its own issue so that it can be worked on and discussed in a manageable way.

    Steps to reproduce

    Proposed resolution

    1. Update core.config_overview.html.twig with a brief note about how it's possible to install a site from configuration.
    2. Add a new topic with steps for installing a site from configuration.
    3. Add the new topic to the frontmatter's related list in core.config_overview.html.twig.

    Note: Help Topics is being merged with the core Help module and help topics will be eventually moved to their own modules, so the locations of these files may shift.

    Remaining tasks

    User interface changes

    API changes

    Data model changes

    Release notes snippet

📌 Task
Status

Active

Version

11.0 🔥

Component
Help 

Last updated 13 days ago

No maintainer
Created by

🇺🇸United States Amber Himes Matz Portland, OR USA

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Merge Requests

Comments & Activities

  • Issue created by @Amber Himes Matz
  • 🇩🇪Germany Martin Mayer Germany and Philippines
  • Pipeline finished with Failed
    30 days ago
    Total: 944s
    #365105
  • 🇩🇪Germany Martin Mayer Germany and Philippines
  • 🇺🇸United States smustgrave

    For the feedback on the MR.

  • 🇺🇸United States Amber Himes Matz Portland, OR USA

    Thank you for working on this @martin mayer.

    For you, or anyone else working on this, please refer to the proposed resolution in the issue summary as well as the Help Topics Standards doc.

    For help topics, we like to split up topics into "concepts" (usually has "overview" in the title or filename) and "tasks" (step-by-step instructions on how to do a certain task). Which means, we don't want to introduce step-by-step instructions into a concept (aka "overview") topic. But rather, add a task topic with steps, and then link to it from the related concept/overview tutorial.

    So for this issue, what we need is an update to the Help module's concept topic (core.config_overview.html.twig) that describes at a high level that it is also possible to install a site from existing configuration, which bypasses the need to discover a site's UUID.

    And then we need a new help topic in core/modules/help/help_topics called something like core.config_install.html.twig that has step-by-step instructions on installing an existing site from configuration, including any limitations (such as those described in 🐛 Allow an install hook in profiles installing from configuration Needs work ).

    Then in both core.config_overview.html.twig and the new topic, update the related topics to include links to each other.

    I realize that there is limited documentation on this task, and that the best (only?) way to accomplish it is through Drush. If that is the case, in an "Additional resources" section, add a link to this User Guide page on additional tools: https://www.drupal.org/docs/user_guide/en/install-tools.html. For any Drush commands, wrap them in HTML <code> tags.

  • 🇺🇸United States Amber Himes Matz Portland, OR USA

    Updated IS with link to Help Topic Standards doc.

Production build 0.71.5 2024