Contrib.social

Use schemas to provide the structure for generating and validating Recipes

Open on Drupal.org →
Created on 20 September 2024, 3 months ago

Problem/Motivation

Currently, the documentation is being updated manually, see example https://www.drupal.org/project/distributions_recipes/issues/3449438 →

The documentation lives on https://git.drupalcode.org/project/distributions_recipes/-/tree/1.0.x/docs

As the code is evolving, the documentation becomes obsolete and further manual steps are required to keep it up to date. It takes time and human effort to keep it up to date.

Proposed resolution

I would like to propose the introduction of Schema that can be used for generating and validating Recipes.
This would be beneficial for the following cases:
- Automatically update the documentation when the schema changes (This could be a Scheduled task on Gitlab)
- The schema could be used by the → to be the source of data for the autocomplete actions.
- The schema could also be used by the →
- The schema could be used in tests, to make sure that changes are validated against the schema.

For the implementation, it requires some exploration, but we could look into things like:
- Storing the schema in json format
- Using a tool like for validation
- Using tools to generate documentation i.e.

Remaining tasks

- Evaluate if this is a good idea and it is doable
- Decide the structure of the schema
- Find the best tool for generating documentation

✨ Feature request
Status

Active

Version

11.0

Component

Code

Created by

🇬🇧United Kingdom marcelovani London

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

Comments & Activities

contrib.social Blog FAQ Discussions
Production build 0.71.5 2024