Document configuration schema with a dedicated @config_schema_api @defgroup

Created on 28 September 2014, almost 10 years ago
Updated 22 March 2023, over 1 year ago

This came up in #2144413: Config translation does not support text elements with a format β†’

Problem/Motivation

  • People who need to write configuration schema cannot find an introductory overview to the idea and concepts of configuration schema
  • There is no place to document certain important details about the configuration schema

Proposed resolution

Create a @config_schema_api @defgroup.

Things to document:

  • The general idea behind configuration schema
  • The structure of configuration schema, where to put files, etc.
  • Some commonly used types, such as mapping, string, etc.
  • Translatability, i.e. text vs. label
  • …

Remaining tasks

User interface changes

No.

API changes

No.

πŸ“Œ Task
Status

Active

Version

9.5

Component
ConfigurationΒ  β†’

Last updated 22 minutes ago

Created by

πŸ‡©πŸ‡ͺGermany tstoeckler Essen, Germany

Live updates comments and jobs are added and updated live.
  • Documentation

    Primarily changes documentation, not code. For Drupal core issues, select the Documentation component instead of using this tag. In general, component selection is preferred over tag selection.

Sign in to follow issues

Comments & Activities

Not all content is available!

It's likely this issue predates Contrib.social: some issue and comment data are missing.

Production build 0.69.0 2024