Update README/project page with install instructions

Created on 30 November 2023, 7 months ago

Problem/Motivation

I can't seem to get this module to load its configuration pages on a fresh install of Drupal 10.1.5. Is there a trick to it?

The project page or README.md (or both) could use an update. Here are the current instructions from the README:

  1. Copy/upload the module to the modules' directory of your Drupal installation. (works)
  2. Enable the module in 'Extend' (/admin/modules). (works)
  3. Configure the module to define new patterns. (/admin/structure/component-library-pattern). (Is this supposed to be "admin/structure/component-library"?)
  4. Then create variations for the pattern. (I'm stuck here)

The remaining two steps in the README probably should be separated out, since they're not steps at all but additional information:

  • The module as an API does not require any specific component system's module.
  • However, if installed, ui_patterns integration is available.

Steps to reproduce

  1. Install the module with composer: composer require 'drupal/component_library:^1.0@alpha'
  2. Visit admin/structure/component-library
  3. Now click on "Component library assets" or "Component library patterns"
  4. Neither page is loaded. It seems to get in an infinite loading loop.

This is with DDEV 1.22.5 on Ubuntu 22.04.

Proposed resolution

Whatever is causing the infinite loading will need to be fixed, but I'm also curious what the difference is that makes the pages not load in the first place. I've seen this module working for others so there must be a missing setup step. Updating the README and project page would help new users get set up.

πŸ› Bug report
Status

Active

Version

1.0

Component

Documentation

Created by

πŸ‡ΊπŸ‡ΈUnited States quicksketch

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

Comments & Activities

Production build 0.69.0 2024