Problem/Motivation

We need documentation to onboard people to the Starshot Demo Design System project.

This issue is focused on the validation guide.

Note: Validation is at the code level whereas the testing doc will focus on testing in UI.

Steps to reproduce

Proposed resolution

Info to include:

  • Coding Standards
  • SDC Validation
  • Twig Validation

Remaining tasks

  • Gather info and links
  • Create draft in Google docs
  • Port to community initiative guides

User interface changes

API changes

Data model changes

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
Parent issue: #3464543: Create SDDS project testing guide » #3464535: [META] Create SDDS documentation

Fix parent.

kristen pol’s picture

kristen pol
she/her
Primary language English
Location Santa Cruz, CA, USA
commented
Assigned: kristen pol » Unassigned
Status: Needs work » Needs review

Although this is not done, moving to needs review for feedback.

In particular, would love if people have thoughts on other types of validation that would be helpful at the theme/code level.

kristen pol’s picture

kristen pol
she/her
Primary language English
Location Santa Cruz, CA, USA
commented
Issue summary: View changes

Doc is here:

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

sea2709’s picture

sea2709 commented

I'm thinking it's probably helpful if we leverage some UI functions that UI Patterns provides to have an overview about components on the site. When we navigate to this page https://starshot.ddev.site/admin/reports/ui-components , it provides us a list of SDC components, and we can go to an individual component to see what errors and warnings of this component.

sea2709’s picture

sea2709 commented

CL Devel module provides similar feature to list all components and their props and slots info at https://starshot.ddev.site/admin/config/user-interface/sdc/registry , it looks like UI Patterns provides more info.

Kristen Pol credited jacobadeutsch.

kristen pol’s picture

kristen pol
she/her
Primary language English
Location Santa Cruz, CA, USA
commented
Assigned: Unassigned » kristen pol
Status: Needs review » Needs work

Gotcha. I thought that the UI Patterns page only picked up ones that were using UI Patterns (which SDDS+CivicTheme are not) so I'll take a look because more info is better :)

Also Jacob found some issues with this page (using wrong linter) so I need to update for that too.

kristen pol’s picture

kristen pol
she/her
Primary language English
Location Santa Cruz, CA, USA
commented
Assigned: kristen pol » Unassigned
Status: Needs work » Needs review

I may yank out the CL Devel stuff but leaving it for now.

The full validation guide has been updated and is ready for review.

kristen pol’s picture

kristen pol
she/her
Primary language English
Location Santa Cruz, CA, USA
commented
Status: Needs review » Needs work

@sea2709 Do you want to take a stab at updating the doc to use /admin/reports/ui-components from #5? We can still leave the CL Devel stuff for now.

kristen pol’s picture

kristen pol
she/her
Primary language English
Location Santa Cruz, CA, USA
commented
Status: Needs work » Fixed

I've updated to move ui patterns and cl devel stuff to the "ignore" section. This is "done" for now.

Status: Fixed » Closed (fixed)

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