drupal-pattern-lab / roadmap

2 stars 0 forks source link

Discuss Starter Kits: What Structure / Partials should be in the "core" starterkit vs our unique kits? #6

Open finteractive opened 7 years ago

finteractive commented 7 years ago

With the default starter kit that's being worked on here https://github.com/drupal-pattern-lab/edition-php-twig-standard/ this comes with a pre-defined folder structure that is in my opinion confusing to Drupal folks as they both reserved terminology for Drupal themes/structures.

In Atomic Jargon

My team has settled on Layouts (=Atomic Templates) & Mockups (=Atomic Pages) as the equivalent folders. There's less confusion compared to the default folders.

Questions

EvanLovely commented 7 years ago

Just wanted to jump in here and say that I think this is a very important topic as it's what people see when they first open Pattern Lab, it's what enables so many different interpretations of that possible while still harnessing the same underlying codebase... and it's where we have lots of opportunities to improve how it's done.

I think the choices are important as this is where things get very opinionated very quickly and that's a good thing.

I see these next steps being needed:

I also think that simply having some docs (in readme, or docs folder, or on website) that show how to install a StarterKit in an existing site would be good as it'd let people try different ones out without having to do a complete re-install. This is the command that would do it:

php core/console --starterkit --install GitHubUser/REPO

If it was on the website, it'd be super awesome to have the demo hosted somewhere so one could see it as well.

To come back to your question, I think the place for these things for now is in your company's StarterKit. If you feel like it gets to a point that it's fleshed out and thorough, go ahead and put up a PR to have it be one of our StarterKit suggestions!

cybtachyon commented 6 years ago

I would also like to recommend that any partials (patterns/components etc.) that are shared are kept in a separate pattern library.

For example, a generic image partial, media item, HTML element with attributes, or other generic components would be best suited for their own repo so they can be used by other projects or implementations, or even dropped in favor of a user's own partials.

Partials that are Drupalisms or specific to this Drupal Pattern Lab project should remain in the base project repo.

This opinion is formed from the experience struggling to maintain a library of components that ended up being re-used on site after site, when the components were not in a central pattern library repo.