Skip to content

Commit

Permalink
Add "value created" list (#7)
Browse files Browse the repository at this point in the history
* ADR clarity improvements.

* Documentation cleanup.

* Add "value created" document with an initial entry.

* Add links to main readme
  • Loading branch information
danielnaab authored Oct 23, 2023
1 parent 129a99f commit 582f122
Show file tree
Hide file tree
Showing 7 changed files with 83 additions and 52 deletions.
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,11 @@ The project dependencies within the workspace are:

![workspace project dependencies](./workspace-dependencies.svg)

Additional documentation:

- [Architectural Decision Records (ADRs)](./documents/adr/)
- [Non-project contributions](./documents/value-created-log.md)

## Development

This project uses [pnpm workspaces](https://pnpm.io/workspaces). To work with this project, [install pnpm](https://pnpm.io/installation) and then the project dependencies:
Expand Down
4 changes: 2 additions & 2 deletions documents/adr/0005-build-system.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@ A method of structuring cohesive and well-encapsulated modules is required. Addi

A [pnpm](https://pnpm.io/) workspace will be utilized. Workspaces are a standard method of organizing multiple interdependent [node.js](https://nodejs.org/) packages in a single repository. pnpm offers efficient package management and well-implemented workspaces.

[Turborepo](https://turbo.build/) will be leveraged to managed efficient builds. In a multi-project workspace, tracking interdependencies between packages is required. Turborepo implements an efficient caching system and executing engine that leads to efficient and developer-friend builds.
[Turborepo](https://turbo.build/) will be leveraged to managed efficient builds. In a multi-project workspace, tracking interdependencies between packages is required. Turborepo implements an efficient caching system and execution engine that leads to efficient and developer-friend builds.

## Consequences

Reasoning about dependencies will be enhanced with explicit packages per module. Additionally, dependencies will be modularized with in a manner that makes it easy to lift and shift the code to another location with a pnpm workspace. Lastly, developer efficiency will be enhanced by the fast builds provided by Turborepo.
Reasoning about dependencies will be enhanced due to each module having an explicit package. Additionally, dependencies will be modularized in a manner that makes it easy to lift and shift the code to another location. Lastly, developer efficiency will be enhanced by the fast builds provided by Turborepo.
2 changes: 1 addition & 1 deletion documents/adr/0007-initial-css-strategy.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ The project team desires a method of managing CSS using a method that maximizes

The project team will theme USWDS via an encapsulated build (`@atj/design`). Any USWDS-related configuration or initialization will reside in this package.

Where necessary, the Spotlight frontend application will use straight CSS.
The Spotlight frontend will leverage this package via CSS imports. Where necessary, the Spotlight frontend application will use straight CSS.

## Consequences

Expand Down
5 changes: 5 additions & 0 deletions documents/value-created-log.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Value created

The project team aims to stack the value it creates throughout the development of this project by improving the federal forms landscape wherever possible. This document lists notable contributions made by the project team to other efforts.

- [uswds-compile PR#76](https://github.com/uswds/uswds-compile/pull/76) updates [uswds-compile](https://github.com/uswds/uswds-compile) to be compatible with alternate package managers, such as [pnpm](https://pnpm.io/).
2 changes: 1 addition & 1 deletion packages/dependency-graph/src/graph-dependencies.ts
Original file line number Diff line number Diff line change
Expand Up @@ -19,5 +19,5 @@ export const writeDependencyGraph = (
dependencyGraphOutputPath: string
) => {
const graph = createGraphvizDigraph(workspaceDependencies);
graph.output('svg', dependencyGraphOutputPath);
graph.output({ type: 'svg', use: 'dot' }, dependencyGraphOutputPath);
};
3 changes: 3 additions & 0 deletions packages/design/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# @atj/design

This package encapsulates all the CSS styles used in 10x Digital Access to Justice frontend applications. See [documents/adr/0007-initial-css-strategy](../../documents/adr/0007-initial-css-strategy.md).
114 changes: 66 additions & 48 deletions workspace-dependencies.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 582f122

Please sign in to comment.