Skip to content

Commit

Permalink
Merge branch 'main' into ghas-enforcement-codeql
Browse files Browse the repository at this point in the history
  • Loading branch information
humancompanion-usds authored Oct 12, 2023
2 parents 8ddadf5 + 9e48af5 commit a487487
Show file tree
Hide file tree
Showing 133 changed files with 9,060 additions and 3,950 deletions.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/1_bug_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
name: "1. \U0001F534 Bug report"
about: Something in the Design System is not working as expected
title: ''
labels: vsp-design-system-team, bug
labels: platform-design-system-team, bug

---

Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/2_documentation_request_form.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
name: 2. 📖 Documentation request form
description: Suggest an update to documentation
labels: ["vsp-design-system-team"]
labels: ["platform-design-system-team"]
body:
- type: checkboxes
attributes:
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/3_experimental_design_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
name: "3. Experimental design system request"
about: Propose an idea for a new component or pattern
title: "Experimental Design [component or pattern name]"
labels: vsp-design-system-team, experimental_design
labels: platform-design-system-team, experimental_design

---

Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/4_support_question.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
name: "4. \U0001F64B Support question"
about: If you need support using the Design System
title: ''
labels: 'vsp-design-system-team'
labels: 'platform-design-system-team'

---

Expand Down
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/DST-basic_issue_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
name: "DST - Basic Issue Template"
about: INTERNAL DST USE ONLY
title: ''
labels: vsp-design-system-team
labels: platform-design-system-team

---
## Configuring this issue
Expand All @@ -23,4 +23,4 @@ _optional, delete section if not needed_


## Acceptance Criteria
- [ ]
- [ ]
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/DST-component_accessibility_review.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
name: "DST - Component accessibility review"
about: INTERNAL DST USE ONLY
title: "[component name] - Accessibility review"
labels: vsp-design-system-team
labels: platform-design-system-team

---
## Configuring this issue
Expand All @@ -24,4 +24,4 @@ We need to conduct a full accessibility review of the [component name] component

## Acceptance Criteria
- [ ] Component has been reviewed for accessibility issues
- [ ] Any accessibility issues have been addressed
- [ ] Any accessibility issues have been addressed
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/DST-component_design.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
name: "DST - Component design"
about: INTERNAL DST USE ONLY
title: "[component name] - Design"
labels: vsp-design-system-team
labels: platform-design-system-team
assignees: babsdenney, LillyBoot

---
Expand Down
8 changes: 4 additions & 4 deletions .github/ISSUE_TEMPLATE/DST-component_development.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
name: "DST - Component development"
about: INTERNAL DST USE ONLY
title: "[component name] - Development"
labels: vsp-design-system-team, dst-engineering
labels: platform-design-system-team, dst-engineering

---

Expand All @@ -25,10 +25,10 @@ If this is a pattern or component that is already in existence, check the Design

## Tasks
- [ ] Review DST backlog for outstanding issues with this component, if necessary
- [ ] Create web component and add to Storyboook
- [ ] Create web component and add to Storybook
- [ ] Write any necessary tests
- [ ] Add Chromatic link to #[add accessibility ticket number] and request review from an accessibility specialist
- [ ] Ping designer for design review
- [ ] Contact designer for design review
- [ ] Display the appropriate [maturity scale](https://design.va.gov/about/maturity-scale) option in Storybook (once this feature is available)
- If this is a new component that has not gone through Staging Review, it should be labeled "Use with Caution: Candidate"
- [ ] Merge component
Expand All @@ -40,4 +40,4 @@ If this is a pattern or component that is already in existence, check the Design
- [ ] Component is written and added to Storybook
- [ ] Component has had accessibility and design reviews
- [ ] Design.va.gov has the latest version of component-library
- [ ] Analytics has been configured for the component in the `vets-website` repo
- [ ] Analytics has been configured for the component in the `vets-website` repo
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/DST-component_documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
name: "DST - Component documentation"
about: INTERNAL DST USE ONLY
title: "[component name] - Documentation"
labels: vsp-design-system-team
labels: platform-design-system-team

---

Expand Down Expand Up @@ -30,4 +30,4 @@ Be sure to use the appropriate [maturity scale](https://design.va.gov/about/matu
- [ ] Once documentation is approved, publish to design.va.gov

## Acceptance Criteria
- [ ] Component documentation is published on design.va.gov
- [ ] Component documentation is published on design.va.gov
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/DST-component_final_review.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
name: "DST - Component final review"
about: INTERNAL DST USE ONLY
title: "[component name] - Final Review"
labels: vsp-design-system-team
labels: platform-design-system-team

---

Expand Down Expand Up @@ -42,4 +42,4 @@ Sample announcement:
## Acceptance Criteria
- [ ] All items on the checklist are checked off and links have been added
- [ ] Any comments from the staging review have been addressed
- [ ] Component announcement has been added to the "What's New Confluence page for the month
- [ ] Component announcement has been added to the "What's New Confluence page for the month
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/DST-component_pattern_audit.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
name: "DST - New component or pattern audit"
about: INTERNAL DST USE ONLY
title: "[component or pattern name] - Audit"
labels: vsp-design-system-team
assignees: GnatalieH
labels: platform-design-system-team
assignees: babsdenney, LillyBoot

---

Expand Down
66 changes: 66 additions & 0 deletions .github/ISSUE_TEMPLATE/DST_component_Figma.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
---
name: "DST - Component Figma"
about: INTERNAL DST USE ONLY
title: "[component name] - Design"
labels: platform-design-system-team
assignees: babsdenney, danbrady

---

## Configuring this issue
- [ ] Add issue to appropriate epic
- [ ] Add Design System component label (such as `va-alert`)
- [ ] Add `component-new` or `component-update` label, if applicable
- [ ] Complete sections below
- [ ] Delete this section once complete

## Description
Create [component name] and/or update in Figma.


## Details
Confluence page with instructions: https://vfs.atlassian.net/l/cp/JR0BtAa1


## Tasks
- [ ] Create designs for component in Figma
- [ ] Review designs with PO and/or other DST designers
- [ ] Review designs with an accessibility specialist
- [ ] Review designs with DST members
- [ ] Address any comments from reviews, if necessary
- [ ] Comment on this ticket with any accessibility considerations engineers may need to know
- [ ] Comment on this ticket with content specifications (e.g. labels and error messages)
- [ ] Comment on this ticket with a link to the designs and post in DST Slack channel


## Acceptance Criteria
Styles & Variables/Token 
- [ ] All components should be connected to VADS Component Library styles & Variables
- [ ] All components should be connected to the proper style or variable/token 
- [ ] Colors: connected to the correct color token (not primitive!) - can be found in local variables library
- [ ] Typography: connected to the correct text style - under local styles
- [ ] Spacing: connected to the correct spacing token or primitive 
- [ ] Icons: connected to correct icon - can be found on foundation page
Auto layout
- [ ] Components should be as reactive as possible. Most, if not all, components should be able to be resize for either mobile, tablet, or desktop sizes 
- [ ] The correct spacing should be applied to auto layout 
Properties
Note: Not all components need every property. It will differ component to component 
- [ ] Variants: Should be used when the component has several states i.e primary, secondary, error 
- [ ] Boolean: Should be used if the component has a part that does not always need to be shown i.e icons, nested components and mobile view
- [ ] Text: Should be used when the test on a component needs to be changed. There are some exceptions to this if the component has several variants that need to have different/specific text. When you change the text on the parent component it will change all of the variants
- [ ] Instance Swap
- [ ] Should be used if there is a part of the component that needs to be switched out but nothing else needs to change i.e. icons Color contrast (Pro Tip: The plugin “Contrast” can help with this.)
- [ ] Test as a DS library user
- [ ] Connect your Figma design file to the DS library found in the Assets panel, Team Library (open book icon)
- [ ] After connecting to the library, use the Assets panel to view all components
- [ ] Does the component naming make sense and follow storybook?
- [ ] Try to break the component! Test on asset NOT parent component
- [ ] Expand/shrink the asset and put into containers
- [ ] change body text and/or header from a sentence to paragraph
- [ ] make sure text wraps correctly
- [ ] the component should expand or shrink with text
- [ ] Test all combinations of properties



27 changes: 27 additions & 0 deletions .github/workflows/pull-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
name: Pull Request

on:
pull_request:
types: [ready_for_review, synchronize, reopened, opened]
jobs:
build:
strategy:
matrix:
environment: [{ bucket: dev-design.va.gov, config: dev.yml }, { bucket: staging-design.va.gov, config: staging.yml }, { bucket: design.va.gov, config: prod.yml }]
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
with:
fetch-depth: 0
- name: Use Node.js 14.x
uses: actions/setup-node@v2
with:
node-version: 14.x
cache: 'npm'
- uses: ruby/setup-ruby@v1
with:
ruby-version: 2.7.5 # Not needed with a .ruby-version file
bundler-cache: true # runs 'bundle install' and caches installed gems automatically
- run: npm install
- run: npm run-script build
- run: bundle exec jekyll build --config _config.yml,jekyll-configs/${{ matrix.environment.config }}
1 change: 1 addition & 0 deletions .nvmrc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
18.14.0
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Vets Design System Documentation

This is repo for the design system documentation, aka [design.va.gov](https://design.va.gov). If you are looking for the repo that contains the CSS and Javascript for the components, see the [formation package](https://github.com/department-of-veterans-affairs/veteran-facing-services-tools/tree/master/packages/formation) inside the [veteran-facing-services-tools repo](https://github.com/department-of-veterans-affairs/veteran-facing-services-tools).
This repo is for VA Design System documentation, aka [design.va.gov](https://design.va.gov). If you are looking for the repo that contains the design system components, see the [component-library](https://github.com/department-of-veterans-affairs/component-library). Additionally, the [Formation package](https://github.com/department-of-veterans-affairs/veteran-facing-services-tools/tree/master/packages/formation) inside the [veteran-facing-services-tools repo](https://github.com/department-of-veterans-affairs/veteran-facing-services-tools) contains sitewide VA.gov base styles and utility classes.

Min specs:

Expand Down Expand Up @@ -93,3 +93,7 @@ While `vets-design-system-documentation` is running and make further updates to
## Deploying

Merges into `main` will automatically be deployed to `dev-design.va.gov`. Production is automatically deployed every weekday at 2pm. Deploys are executed by creating a release of vets-website via Jenkins. You can track the deployment in the Slack channel, #design-system.

## Additional Testing

This project is tested with BrowserStack.
13 changes: 10 additions & 3 deletions _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,16 @@ baseurl: "" # the subpath of your site, e.g. /blog
url: "https://design.va.gov" # Base hostname & protocol for the site

project_name: VA.gov Design System
design_library_name: "Component Symbol Library"

# Common links
sketch_cloud_link: https://www.sketch.com/s/610156b6-f281-4497-81f3-64454fc72156
sketch_cloud_link: https://www.sketch.com/s/a52734dd-00d0-44f1-9c9e-ff4016130e5c
sketch_component_library: https://sketch.com/s/bd089bc0-e3e3-4681-bf72-e6be22b433e4
sketch_templates_link: https://www.sketch.com/s/c8df169f-5b02-4999-befb-34c7b3b62ba9
sketch_form_templates_link: https://sketch.com/s/dc844743-277e-41d4-81ba-a48fd0743952
sketch_annotations_link: https://sketch.com/s/aaa5c25f-6991-4aac-a6ed-d378bdff7727
sketch_wireframes_link: https://www.sketch.com/s/61f7423a-950c-49d2-aee7-96b4a1941eae
sketch_user_flows_link: https://www.sketch.com/s/3b0d625a-ab30-4e83-8084-5987ea5e2bb7
sketch_github_link: https://github.com/department-of-veterans-affairs/vets.gov-team/blob/master/Work%20Practices/Design/Design%20Resources/Pattern%20Library/VA-gov-Pattern-Library.sketch

forms_system_link: https://depo-platform-documentation.scrollhelp.site/developer-docs/VA-Forms-System-Overview.2085355587.html
Expand All @@ -28,11 +33,12 @@ new_component_template_raw_link: https://raw.githubusercontent.com/department-of
new_pattern_template_link: https://github.com/department-of-veterans-affairs/vets-design-system-documentation/blob/main/src/_patterns/template.md
new_pattern_template_raw_link: https://raw.githubusercontent.com/department-of-veterans-affairs/vets-design-system-documentation/main/src/_patterns/template.md
update_documentation_link: https://github.com/department-of-veterans-affairs/vets-design-system-documentation/issues/new?assignees=&labels=vsp-design-system-team&template=2_documentation_request_form.yml
uswds_link: https://designsystem.digital.gov/


# People
sketch_for_teams_admin: "Kevin Hoffman"
sketch_library_owner: "Natalie Hill"
sketch_library_owner: "Lillian Boot, Barb Denney"
experimental_reviewer_1: "Matthew Dingee"


Expand Down Expand Up @@ -88,4 +94,5 @@ exclude:

# Default for building locally.
# See configuration files in jekyll-configs/ for environment overrides.
storybook_path: "http://localhost:6006"
storybook_path: "http://127.0.0.1:6006"
storybook_prod_uswds_path: "https://design.va.gov/storybook/?path=/docs/uswds"
Loading

0 comments on commit a487487

Please sign in to comment.