Problem/Motivation

During the Oct. 30, 2014 CMI meeting (http://bit.ly/1xxCJYU), we decided that it is time to create a meta issue for improving CMI docs. I don't see any other issues that we could convert to a configuration management documentation meta so I am creating a new one.

Proposed resolution

The three main areas that are relevant to this issue are:

Configuration API in Drupal 8: https://www.drupal.org/node/1667894

  • At BADCamp 2013, @jhodgdon and I did a fair amount of updating the overall structure of this section, but much of the information is repeated and needs reorganization.

Managing configuration in Drupal 8: https://www.drupal.org/documentation/administer/config

  • The workflow described in this issue needs to be checked against the current UI

Configuration Management module: https://www.drupal.org/node/1861064

  • This section is OK for general information, but it might be helpful if it more specifically described the Drupal 8 configuration system.

Comments

jhodgdon’s picture

Unless there are some docs in the Drupal Core code base (things appearing on api.d.o) that are incorrect or missing, this is (a) not a Drupal Core issue [move to Documentation project] and (b) not critical.

mtift’s picture

Project: Drupal core » Documentation
Version: 8.0.x-dev »
Component: documentation » Correction/Clarification
Priority: Critical » Major
Issue summary: View changes
jhodgdon’s picture

Issue tags: +d8docs, +developer

Adding tags we use in Documentation issue queue, so people going to https://www.drupal.org/node/1005304 will find it.

xjm’s picture

@webchick also suggested that we should have a child page explaining how configuration data is cleaned up on uninstallation, based on the (bad) things being done in:
http://www.metaltoad.com/blog/migrating-users-drupal-7-to-drupal-8
https://github.com/amitgoyal/d8_migrate_wordpress/blob/master/migrate_wo...

Wim Leers’s picture

#2345225: [meta-0] CMI path to release says this is "kinda critical". Do we want to make this critical?

mtift’s picture

Not according to #1 above.

mtift’s picture

Issue summary: View changes
jhodgdon’s picture

At least some of this information really really really needs to get into the Core help, such as config_help() in config.module. See also #1831798: Update hook_help() for config manager module . It would help if someone who actually understands what the Synchronize page does would write this. I really have no idea, and the UI doesn't clue me in.

AJfun’s picture

Issue summary: View changes
mtift’s picture

I cleaned up the Configuration API in Drupal 8 section a bit, at least removing references to configuration stored in files. A lot of the information is repeated and that section really needs some clean-up in terms of the flow. For example, the Configuration Storage in Drupal 8 is mostly about files, but probably should cover some of the various ways that configuration storage could be configured (e.g. MySQL, YAML files, MongoDB, etc.).

mtift’s picture

Issue summary: View changes

I removed the outdated references to files in https://www.drupal.org/documentation/administer/config.

mtift’s picture

Issue summary: View changes
alexpott’s picture

I'm doing a review of the docs page by page. The review is here https://docs.google.com/document/d/1prc3-rZv4JVNMntAhqjDKY0x7UNwJBUhheq2... and any one can comment. Please do if you fix something.

Reviewed the https://www.drupal.org/documentation/administer/config section so far.

alexpott’s picture

One thing that is definitely going to confuse people the fact that https://www.drupal.org/node/1861064 is for the Drupal 7 module.

jhodgdon’s picture

The corresponding page for Drupal 8 appears to be:
https://www.drupal.org/documentation/administer/config

Probably https://www.drupal.org/node/1861064 should be updated:
- Version taxonomy set to 7.x [ok that is already true]
- Title saying 7.x
- Link at the top to the D8 page/section

I just took care of this... also put a link on the d8 page back to the D7 page.

jp.stacey’s picture

Status: Active » Needs review

From the thread it's not clear what else is required on this issue, so I'm moving it to needs review.

If anyone's aware of any concrete tasks (even if that concrete task is "discuss on IRC/hangout what the concrete tasks are") then please do add them!

jp.stacey’s picture

Status: Needs review » Fixed
Issue tags: +SprintWeekend2017

Given this has been in review for 3 months, I'm going to close it.

If there are specific tasks that must be tracked here, they can always be added and the ticket reopened (although I'd recommend new tickets with a clearer definition of done, referenced from here.)

xjm’s picture

Status: Fixed » Needs work

There are still numerous places in the documentation that say "@todo", so the next step is to write the documentation that goes there. E.g. on https://www.drupal.org/docs/8/api/configuration-api/configuration-entity....