diff --git a/README.md b/README.md index de0df280..423c1e21 100644 --- a/README.md +++ b/README.md @@ -8,18 +8,13 @@ This project is currently in early beta status. It’s used in production on a f Part of our early beta includes learning and collaborating with teams. As the project matures we’ll share more details on how we might meld the design system components into the State template. ### Why a design system -We built this to address common needs identified by California's Office of Digital Innovation (ODI) and the California Department of Technology (CDT) during development of alpha.ca.gov, covid19.ca.gov, cannabis.ca.gov, and drought.ca.gov. +We built this to address common needs identified by California's Office of Digital Innovation (ODI) and the California Department of Technology (CDT) during development of alpha.ca.gov, covid19.ca.gov and cannabis.ca.gov. ### How we work We start by understanding the needs of residents of California through user research. We use an iterative design and development process to provide services that meet these needs. As we work, we continue to test our principles, designs, and components. We prioritize equity to some degree by ensuring that our code is accessible and performant for all devices and bandwidths. Components pass through stages of alpha, beta and production as they become available to the Design System. We work in the open: all our code and issue tracking is public. We’re happy to review pull requests from the public and state employees. Anyone can file an issue with bug reports and feature requests by selecting the **New issue** button from our issues page. You can see the prioritized list of issues we’re addressing on our project board. -## Be a part of the Design System - -We’re looking for partners to share feedback and improve the Design System. - -Reach out to us through the contact form if you’d like to work with us. Or, participate through this GitHub repository. ## Development instructions diff --git a/components/accordion/CHANGELOG.md b/components/accordion/CHANGELOG.md index 771cccab..4fa80530 100644 --- a/components/accordion/CHANGELOG.md +++ b/components/accordion/CHANGELOG.md @@ -14,7 +14,7 @@ * Make use of :defined to enhance design styles. This is available after the custom element's javascript has been executed. ### Upgrade notes 2.0.0 -* **Updated markup structure** please refer to the [README](components/accordion/README.md) for the latest markup example. [See diff](https://github.com/cagov/design-system/pull/698/files#diff-24fcc3b7dc89f0002c127de7c93d334e359cff57a359d69d1a4a7c07002e4c9e) +* **Updated markup structure** please refer to the [README](https://github.com/cagov/design-system/blob/main/components/accordion/README.md) for the latest markup example. [See diff](https://github.com/cagov/design-system/pull/698/files#diff-24fcc3b7dc89f0002c127de7c93d334e359cff57a359d69d1a4a7c07002e4c9e) * When performing this component update, existing accordion markup content will need to be mapped to the new HTML structure in content. Any integrations will also need to update structure and content implementations. ## 1.0.9 diff --git a/components/page-feedback/README.md b/components/page-feedback/README.md index 2313fe4d..a5c3b038 100644 --- a/components/page-feedback/README.md +++ b/components/page-feedback/README.md @@ -13,7 +13,7 @@ The page feedback component is intended to: ## When and how to use it -We're still working on training and data services that supports the page feedback component. If you're interested in using page feedback, [reach out through the Contact us page](/contact-us). We'd like to hear more about your needs as we work on these services. +We're still working on training and data services that supports the page feedback component. If you're interested in using page feedback, [reach out through our Contact us page](https://innovation.ca.gov/contact-us/). We'd like to hear more about your needs as we work on these services. ### How not to use it diff --git a/components/site-navigation/README.md b/components/site-navigation/README.md index c9f9ecf4..bac65fa4 100644 --- a/components/site-navigation/README.md +++ b/components/site-navigation/README.md @@ -365,7 +365,7 @@ Here is an abbreviated example of the data necessary to render this component wi | Cultivation | /licensees/cultivation/ | 20 | 2 | 0 | Drop down | | Manufacturing | /licensees/manufacturing/ | 20 | 2 | 1 | Drop down | -For example, in the WordPress CMS integration, content editors can manage menu links through the normal menu system, and then [data](https://github.com/cagov/cannabis.ca.gov/blob/main/src/templates/wordpress/menu/headerMenu.json) is pulled from the WordPress menu system using an [API plugin](https://github.com/cagov/pantheon-mirror-cannabis-ca-gov/tree/main/wp-content/plugins/wp-rest-api-v2-menus) into a static site building website. This happens by way of GitHub, which acts as a local flat file JSON database for a static site generator (11ty). In the build process of the static site, we then use a [templating system](https://github.com/cagov/cannabis.ca.gov/blob/main/src/templates/_includes/nav-component.njk) to map the JSON data for the menu to the first two levels of the menu to the site navigation. Similar patterns can work for other publishing systems. If you are interested in helping, [reach out through our Contact us page](/contact-us). +For example, in the WordPress CMS integration, content editors can manage menu links through the normal menu system, and then json is pulled from the WordPress menu system using an [API plugin](https://github.com/cagov/pantheon-mirror-cannabis-ca-gov/tree/main/wp-content/plugins/wp-rest-api-v2-menus) into a static site building website. This happens by way of GitHub, which acts as a local flat file JSON database for a static site generator (11ty). In the build process of the static site, we then use a [templating system](https://github.com/cagov/cannabis.ca.gov/blob/main/pages/_includes/site-navigation.njk) to map the JSON data for the menu to the first two levels of the menu to the site navigation. Similar patterns can work for other publishing systems. ## Contributor/developer documentation diff --git a/components/statewide-header/README.md b/components/statewide-header/README.md index 34923429..b31b3b3d 100644 --- a/components/statewide-header/README.md +++ b/components/statewide-header/README.md @@ -11,7 +11,7 @@ It includes: The statewide header is a required Design System component. Place it at the top of the website, above the department branding (site header) and all other content. -If you want to include a translation widget in the statewide header, [reach out through our Contact us page](/contact-us) to find out how you can do so. +If you want to include a translation widget in the statewide header, [reach out through our Contact us page](https://innovation.ca.gov/contact-us/) to find out how you can do so. ### How not to use it diff --git a/docs/pages/contact-us.md b/docs/pages/contact-us.md deleted file mode 100644 index 9fe0d4f1..00000000 --- a/docs/pages/contact-us.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -layout: single-column -title: Contact us -description: Get help from the State of California Design System team, post questions, and share technical information with fellow developers. ---- - -

Have a question? Contact us for help with general inquiries, feedback, or bugs.

- -{%- from "macros/contact-us-form-wrapper.njk" import wrappedContactForm -%} -{{ wrappedContactForm("Contact us") }} - -## Get support from developers - -Post questions on [GitHub](https://github.com/cagov/design-system) and leverage our digital community. diff --git a/docs/pages/get-started.md b/docs/pages/get-started.md index e1e13597..5f794626 100644 --- a/docs/pages/get-started.md +++ b/docs/pages/get-started.md @@ -19,8 +19,4 @@ Get familiar with the [guidelines for content design](/style/content/). ## Everyone -Everyone can benefit from the [Design System principles](/principles/). - -## Need help getting started? - -[Reach out to us](/contact-us/). We’re available to help you figure out how you can get started, even if you do not have a digital team. +Everyone can benefit from the [Design System principles](/principles/). diff --git a/docs/pages/markdown.md b/docs/pages/markdown.md index 98a9fc16..6930e4fe 100644 --- a/docs/pages/markdown.md +++ b/docs/pages/markdown.md @@ -27,7 +27,7 @@ Here's the [full list of labels](https://github.com/highlightjs/highlight.js/blo ## Sprinkle with magic -Inspired by the [MDJS plugin](https://rocket.modern-web.dev/docs/eleventy-plugins/mdjs-unified/), we've created a way to actually run these code blocks on the page. This allows us to both display the code and offer a preview for a given code block. +Inspired by the [MDJS plugin](https://legacy.rocket.modern-web.dev/docs/eleventy-plugins/mdjs-unified/), we've created a way to actually run these code blocks on the page. This allows us to both display the code and offer a preview for a given code block. ### Javascript preview @@ -113,4 +113,4 @@ Next, we'll display and insert the relevant HTML via the `preview` instruction.

Counter: 0

-``` \ No newline at end of file +``` diff --git a/docs/pages/technical-approach.md b/docs/pages/technical-approach.md index 996c8aa8..68748beb 100644 --- a/docs/pages/technical-approach.md +++ b/docs/pages/technical-approach.md @@ -18,7 +18,6 @@ The Design System components are agnostic. You can choose to use an opinionated Right now, the Design System components are in use on pilot sites like: * [covid19.ca.gov](https://covid19.ca.gov/) -* [drought.ca.gov](https://drought.ca.gov/) * [cannabis.ca.gov](https://cannabis.ca.gov/) There’s still a lot of work ahead to develop and refine the components, but we cannot do it in a vacuum. We need feedback from anyone that comes in contact with the components. @@ -31,8 +30,6 @@ Some things we want to include in our next phase are: * More robust accessibility testing * Standardized file names across components -Learn how to [contribute or tell us your ideas](/contact-us/). - ## Component installation The Design System components are individual packages that you can download. Each component has README instructions for how to install it. diff --git a/docs/pages/why-web-components.md b/docs/pages/why-web-components.md index 28d779bf..6260ae92 100644 --- a/docs/pages/why-web-components.md +++ b/docs/pages/why-web-components.md @@ -131,6 +131,5 @@ You can suggest changes or new components by opening issues in the 5 reasons web components are perfect for design systems - Design systems and standards based web components - Why we use web components - - Building web applications with longevity through web components - New to web components? - Introducing: Custom Elements Manifest diff --git a/docs/site/_includes/site-footer.njk b/docs/site/_includes/site-footer.njk index bdeee958..8e9b9928 100644 --- a/docs/site/_includes/site-footer.njk +++ b/docs/site/_includes/site-footer.njk @@ -10,7 +10,7 @@ - + -{% if page.url !== "/error.html" %} - -{% endif %}
-
- Contact us -
+
GitHub @@ -68,4 +63,4 @@ #}
-
\ No newline at end of file + diff --git a/docs/site/_includes/site-navigation.njk b/docs/site/_includes/site-navigation.njk index 8949e518..d28a0f14 100644 --- a/docs/site/_includes/site-navigation.njk +++ b/docs/site/_includes/site-navigation.njk @@ -36,7 +36,7 @@ Principles - +
@@ -56,7 +56,7 @@ @@ -82,25 +82,17 @@
- +
About
- - {# -
-
- Support -
-
- #} {% if env.dev %}
@@ -132,4 +124,4 @@
- \ No newline at end of file + diff --git a/docs/site/homepage.njk b/docs/site/homepage.njk index 57b92929..62cc02bd 100644 --- a/docs/site/homepage.njk +++ b/docs/site/homepage.njk @@ -124,23 +124,7 @@ description: This system makes it easy to build digital services that meet the n -
-
-

Be a part of the Design System

-
-
-
-

We'd love to talk about how we can partner with you.

-
- {%- from "macros/design-system-form.njk" import designSystemContact -%} - {{ designSystemContact("Home page") }} -
-
-
- abstract orrery -
-
-
+

Who's using the Design System

@@ -151,7 +135,7 @@ description: This system makes it easy to build digital services that meet the n

Department of Cannabis Control

This site is the first implementation of Design System components. It proved the design system model works for state departments.

-

Visit +

Visit Department of Cannabis Control cannabis.ca.gov

@@ -163,7 +147,7 @@ description: This system makes it easy to build digital services that meet the n

Broadband for All

The Design System allowed the Broadband for All team to plug-and-play with components on the homepage. With less time spent on engineering, the team could focus more on content and design.

-

Visit +

Visit Broadband for All broadbandforall.cdt.ca.gov