Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update ADRs to accepted #2095

Merged
merged 2 commits into from
Jul 1, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 6 additions & 5 deletions docs/adr/0001-use-adrs.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Architecture Decision Record: Use ADRs
# Use ADRs
📆 **Updated**: June 15, 2022

🙋🏽‍♀️ **Status** Proposed
🙋🏽‍♀️ **Status** Accepted

## ℹ️ Context
There are some specific goals that we have for WebPageTest to ensure that key decisions are made with care, and communicated transparently:
Expand All @@ -12,7 +12,7 @@ There are some specific goals that we have for WebPageTest to ensure that key de
- We want to leave a trail of docoumentation for ourselves so that we can revisit our decisions to see why they were made and if they still make sense.

## 🤔 Decision
We will document our architecure decisions for WebPageTest with an [Architecture Decision Record](https://cognitect.com/blog/2011/11/15/documenting-architecture-decisions)—structured, relatively lightweight records of architectural decisions.
We will document our architecure decisions for WebPageTest with an [Architecture Decision Record](https://cognitect.com/blog/2011/11/15/documenting-architecture-decisions)—structured, relatively lightweight records of architectural decisions.

Our workflow for ADRs will be:

Expand All @@ -28,5 +28,6 @@ Our workflow for ADRs will be:
- We will have a useful set of documentation by default, providing a persisitent record of why decisions were made.

## 📝 Changelog
- 06/15/2021 Proposed
- 06/15/2021 Added Changelog
- 06/15/2022 Proposed
- 06/15/2022 Added Changelog
- 06/15/2022 Accepted
19 changes: 10 additions & 9 deletions docs/adr/0002-design-system-v0.1.md
Original file line number Diff line number Diff line change
@@ -1,33 +1,34 @@
# Architecture Decision Record: Use ADRs
# Design System v.1.0
📆 **Updated**: June 23, 2022

🙋🏽‍♀️ **Status** Proposed
🙋🏽‍♀️ **Status** Accepted

## ℹ️ Context
This is the first step in an iterative refactor approach to a Design System: CSS standardization and consistency.
This is the first step in an iterative refactor approach to a Design System: CSS standardization and consistency.
Across the application we want:
- a consistent color story
- a consistent color story
- consistent typography
- consistent button and form styles
- consistent page container layouts

Currently there are many one off hex colors to represent brand colors and various gray shadows and line breaks. The typography varies by page both with which node type is used as the page header and sub heads and the font-size, font-weight, and font-family of each node. Buttons vary from pill shaped, rounded boxes and default browser style. Page layouts vary on how they line up with the header.


## 🤔 Decision
Create individual .css files for: typograpy, buttons, and layouts. Create a css variable file for brand colors. [see: CSS Variables](https://developer.mozilla.org/en-US/docs/Web/CSS/Using_CSS_custom_properties)
Classes in the typography, buttons and layouts files should be preferred over nodes, so that they can be applied to any node type.
Classes in the typography, buttons and layouts files should be preferred over nodes, so that they can be applied to any node type.

Use the existing design to create the normalized files. This requires decisions to be made around which of our many grays to use, or which button design to use. For now, trust your heart and ask for a design review on PRs where needed.

Since this is an iterative approach, when we modify a page while bug fixing or creating new features, scan the html and css files to normalize using the classes and variables defined in those files.
Since this is an iterative approach, when we modify a page while bug fixing or creating new features, scan the html and css files to normalize using the classes and variables defined in those files.

When we are in a place where we can get implement a more robust design system, this breakdown should make it easier to create new design system rules.

## 🎬 Consequences
- More css files to cache bust
- Some upfront "extra" effort required to make css reusable across pages, which will decrease over time.
- Some upfront "extra" effort required to make css reusable across pages, which will decrease over time.
- Loading more css files, potentially increasing time before a paint can happen

## 📝 Changelog
- 06/23/2021 Proposed
- 06/23/2022 Proposed
- 06/23/2022 Accepted