Contrib.social

Documentation improvements

Open on Drupal.org →
Created on 4 May 2023, over 1 year ago
Updated 5 May 2023, over 1 year ago

Problem/Motivation

Hey gang:

I recently went the full distance on getting cl_server to work with Drupal 10.1 + Single Directory Components and wanted to both share my experience and directly improve the documentation that ships with this module so that others can have an easier time.

Controversially, I'm also keen on providing some DDEV specific documentation on how to get all of this working from inside of a DDEV-based docker container. From there I suspect others could tweak this documentation to fit other Docker helpers like Docksal and Lando.

Summary

A number of things needs to be altered to cater to the Drupal 10 installation requirements
Extra guidance to those of us who are not used to the Javascript tooling experience would be helpful
Need docs on how to create tests | walkthrough the lifecycle / workflows of writing stories.

In Detail

  • Installation process should use Core's SDC module instead of installing it individually from composer
  • Consider adding config previously put into development.services.yml into a different file as composer now wants to overwrite this file with core/assets/scaffold/files/development.services.yml every time you update with composer
  • Need to call out that NPM 14.x is required. Errors were encountered with NPM 16.x.
  • Include explicit instruction that yarn install and not just yarn needs to be run in the project root after running sb init --builder webpack5 --type server otherwise storybook will not have all it's dependencies installed.
✨ Feature request
Status

Fixed

Version

2.0

Component

Code

Created by

🇺🇸United States cosmicdreams Minneapolis/St. Paul

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

Comments & Activities

  • Issue created by @cosmicdreams
  • First commit to issue fork.
  • @e0ipso opened merge request.
  • Comment over 1 year ago →
    System Message
    • e0ipso → committed 3cdfe1de on 2.x 
      Issue #3358282 by e0ipso: Documentation improvements
  • Status changed to Fixed over 1 year ago
  • Comment over 1 year ago →
    e0ipso Can Picafort

    Thanks for reporting this!

    I already had some notes on how to revamp the documentation to keep up with the latest Storybook updates. To be honest there were very little changes regarding to this specific project. Most of the changes were related to ddev and Storybook. I don't necessarily want to keep up with the documentation of other evolving projects, but I also see value of a step by step guide. It's a tricky balance.

    I hope this helps!

  • Comment over 1 year ago →
    System Message

    Automatically closed - issue fixed for 2 weeks with no activity.

contrib.social Blog FAQ Discussions
Production build 0.71.5 2024