Problem/Motivation

As more people get involved as Recipe maintainers, site builders, and end users we need better documentation as guidance for using, creating, and using recipes.

This is a meta issue to organize this effort.

Steps to reproduce

Proposed resolution

Remaining tasks

User interface changes

API changes

Data model changes

Comments

bsnodgrass created an issue.

bsnodgrass’s picture

bsnodgrass commented

I will take a first pass at creating this outline and assign myself after I am done with https://www.drupal.org/project/distributions_recipes/issues/3365724

If anyone else is so inclined in the meantime, please assign yourself and move forward.

sgroundwater’s picture

sgroundwater commented

This dev branch (currently HEAD detached at commit 03f0b02cb2 on branch 11.x) holds important documentation that was created early on. This spot is hard for people to find.

Should we consider moving this dev documentation out to a separate project, and then incorporate it to compliment the the web-facing wiki page that contains the Community Cookbook?

The root of the documentation in the dev branch is here: https://git.drupalcode.org/project/distributions_recipes/-/tree/03f0b02cb2e87d34dadd07a53eed1fa0f1c5bdad

I like a plan where the current public wiki page for Cookbooks and Related Projects (Link two) can managed as an open resource directory, so maintainers can self identify into the listing. Then incorporate the "Recipe Features Guide" with this wiki page. (Dev branch docs)

Keep the "Recipe Feature Guide" in a repository. Maybe consider converting the MD documentation files into a Gitlabs Page and serve things right from the documentation repo.

Ideas, suggestions?

Reference Doc Link One:
https://www.drupal.org/docs/extending-drupal/drupal-recipes

Reference Doc Link Two:
https://www.drupal.org/docs/extending-drupal/contributed-modules/contrib...

thejimbirch’s picture

thejimbirch commented

The docs are in the 1.x branch: https://git.drupalcode.org/project/distributions_recipes/-/tree/1.0.x

We have no maintainer and end user documentation currently, so I don't think where to host them is the important part. Documenting all the things is the important part.

I think we should continue to document things in the 1.x branch using git and these issues. Once they are in a good spot, we can figure out next steps.

sgroundwater’s picture

sgroundwater commented

Documentation for recipes is being managed in the 1.x project branch. https://git.drupalcode.org/project/distributions_recipes/-/tree/1.0.x

Features and discussions are in the project issues. https://www.drupal.org/project/issues/distributions_recipes

A "Recipes Cookbook" page with community information can be found within Drupal.org project documentation.
https://www.drupal.org/docs/extending-drupal/contributed-modules/contrib...

#!/bin/bash
# commands to pull a local copy of the distributions & recipes documentation. 
git clone https://git.drupalcode.org/project/distributions_recipes.git
cd distributions_recipes
git fetch origin
git checkout -b 1.0.x origin/1.0.x
git branch