Create SDDS project development guide

Work is happening here:

https://www.drupal.org/community-initiatives/starshot-demo-design-system... →

This has been done except for:

• Enable theme and SDC debugging
• Configure Storybook

There has been feedback in Slack on issues with the steps which I'll be incorporating today.

Copying my comments from slack

Faced some issues while setting up local site (Drupal 10.3, not the Starshot prototype), following the developer guide. Posting them here along with the workarounds followed
ddev composer require drupal/demo_design_system
Error: Could not find a version of package drupal/demo_design_system matching your minimum-stability (stable)
Workaround: First run ddev composer config minimum-stability dev , then ddev composer require drupal/demo_design_system

drush ev "require_once dirname(\Drupal::getContainer()->get('theme_handler')->rebuildThemeData()['civictheme']->getPathname()) . '/theme-settings.provision.inc'; civictheme_enable_modules();"
Error: Unable to install modules due to missing modules search_api, search_api_db
Workaround: Not sure why the search_api module is a dependency. For now I manually downloaded both the modules (search_api and search_api_db)

ddev drush then demo_design_system
Error: Unknown themes: demo_design_system
Workaround: The theme files are still in the format civictheme.*.yml . So used ddev drush then civictheme to install the theme.

But, Overall the SDDS documentation is really great and provides a good understanding of the initiative, especially the contribution and SDC conversion guides.

Just now followed the updated development guide on mac and i was able to do the setup without any issues.

Thanks 🙏 I’ve added a few more steps on the bottom as I work through things like the SDC registry. Leaving this open because I still need to add the experience builder steps but it’s unclear if when I installed is what’s expected

Also if you have thoughts on additional sections, let me know

I followed this guide to set up again yesterday. I left some comments in the discussion panel at https://www.drupal.org/community-initiatives/starshot-demo-design-system... →

If it is easier for you if I leave comments here, just let me know!

Thanks 🙏 I’ll try to review and update today 👍

Noticed a tiny issue. 's' is not hyperlinked in 'settings'.

Thanks! Lots going on and I haven't forgotten everyone's feedback... will try again today :)

Kristen Pol → credited the_g_bomb → .

I have made changes based on suggestions here and in the doc.

@sea2709 Note that I left the git clone for adding the demo_design_system because I want people to be able to work with branches if necessary.

Also, the D10 section was removed for easier installation and since we should test with that anyway.

Thanks, everyone!

@Kristen: Actually, using dev version in composer allows you to switch branch on your local. You can go to the theme directory and do git checkout another branch or commit changes.

I found this article that might be helpful https://www.drupal.org/docs/develop/using-composer/tricks-for-using-comp... →

There is one thing to note about ddev quick-start. Using "ddev quick-start" will re-install the site again, all new data is wiped out. From the second time starting the site, I think ddev start is good enough!

Thanks @sea2709! I'll get #16 added as a note. For #15, I'll need to look at this more carefully. At the moment, there is not dev branch of experience_builder available via d.o so not sure that will work for that one.

Moving back to needs work per above.

@Kristen: I don't have a good explanation about how composer works when we use it to checkout branches. This is what I did to clone experience_builder module. Since there is no dev branch for experience_builder, I modify the repositories section

"repositories": {
        "drupal/experience_builder": {
            "type": "vcs",
            "url": "https://git.drupalcode.org/project/experience_builder.git"
        },
        ...
}

Then I did ddev composer require drupal/experience_builder:@dev . And my experience_builder folder is at the latest commit and I can switch branches!

Thanks! I'm checking with the XB team to see if they can at least create a dev release so it's one less step for us.

I've asked about the XB dev release but don't think it'll be added so I'll need to update the docs with this info.

Okay... I've updated the instructions with:

ddev composer config repositories.drupal-experience-builder vcs https://git.drupalcode.org/project/experience_builder.git
ddev composer require drupal/experience_builder:@dev

which worked. Thanks!

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