Problem/Motivation

For the initial set up of SDDS, we copied over CivicTheme and checked in the build artifacts as well. This makes the codebase bloated.

Steps to reproduce

Proposed resolution

We should remove those build artifacts, add those build files/directories to .gitignore, and update the README and docs to make sure the build steps is included.

Remaining tasks

  • Identify minimal amount of files/directories needed in codebase
  • Identify the files/directories that are built with npm run build for base theme and subtheme
  • Update .gitignore to not include these built files/directories
  • Update README and dev guide with correct steps to install base theme and subtheme
  • Create MR with changes
  • Review and test per below
  • Commit :)

Testing:

  • Go through the process of installation with composer require, npm run build, and drush theme:install
  • Check both themes show up in list of themes and both theme settings can be edited
  • Check both themes have their Storybook available within their theme settings

User interface changes

Nothing in the UI but files/directories in theme will be tidier out-of-the-box.

API changes

Data model changes

Issue fork demo_design_system-3469781

Command icon Show commands

Start within a Git clone of the project using the version control instructions.

Or, if you do not have SSH keys set up on git.drupalcode.org:

About issue forks

Comments

kristen pol created an issue. See original summary.

kristen pol’s picture

kristen pol
she/her
Primary language English
Location Santa Cruz, CA, USA
commented
Assigned: kristen pol » joshua1234511

Assigning to Joshua for next week.

kristen pol’s picture

kristen pol
she/her
Primary language English
Location Santa Cruz, CA, USA
commented

Note that if we have to change the Twig namespaces to SDC syntax then Storybook won't be testable. See #3469985: Reconcile components module vs SDC namespaces for SDDS includes/embeds.

joshua1234511 made their first commit to this issue’s fork.

joshua1234511 opened merge request !31

joshua1234511’s picture

joshua1234511
Primary language English
Location Goa
commented
Assigned: joshua1234511 » kristen pol
Status: Active » Needs review

MR: https://git.drupalcode.org/project/demo_design_system/-/merge_requests/31

Task
Identified minimal amount of files/directories that are built with npm run build for base theme and subtheme
Updated .gitignore to not include these built files/directories
Update README and dev guide with correct steps to install base theme and subtheme

Reviewed and tested locally
Following steps from https://www.drupal.org/community-initiatives/starshot-demo-design-system...

Update README and dev guide with correct steps to install base theme and subtheme
- No update required as steps already added
https://www.drupal.org/community-initiatives/starshot-demo-design-system...
Step 3: Configure and enable base theme
Step 5: n addition to enabling the base civictheme theme, we have a subtheme with the custom branding and components for Drupal CMS, so we need to configure and enable that too

kristen pol’s picture

kristen pol
she/her
Primary language English
Location Santa Cruz, CA, USA
commented

Code changes look good. I'll test :)

kristen pol’s picture

kristen pol
she/her
Primary language English
Location Santa Cruz, CA, USA
commented
Status: Needs review » Reviewed & tested by the community

This is working well. I'll get it merged.

kristen pol’s picture

kristen pol
she/her
Primary language English
Location Santa Cruz, CA, USA
commented
Assigned: kristen pol » Unassigned
Status: Reviewed & tested by the community » Fixed

Merged! Thanks :)

kristen pol’s picture

kristen pol
she/her
Primary language English
Location Santa Cruz, CA, USA
commented

Just double checked:

https://git.drupalcode.org/project/demo_design_system

against:

https://github.com/civictheme/monorepo-drupal/tree/develop/web/themes/co...

and it looks similar. Of course, we have components and starshot_demo but that's to be expected.

Status: Fixed » Closed (fixed)

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