Skip to content

Commit

Permalink
Merge pull request #177 from guardian/jl/update-readme
Browse files Browse the repository at this point in the history
Add notes about discussions and ADRs to README
  • Loading branch information
Jamie Lynch authored Jan 19, 2021
2 parents 1968aed + cc909d3 commit 95e3d78
Showing 1 changed file with 10 additions and 2 deletions.
12 changes: 10 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ Welcome to the Guardian CDK library! This library contains a number of reusable

📖 View the available components in the [API documentation](https://guardian.github.io/cdk/).

💬 Come and chat to us in [Discussions](https://github.com/guardian/cdk/discussions)

## Wait, what is CDK?

> The AWS Cloud Development Kit (AWS CDK) is an open-source software development framework to define cloud infrastructure in code and provision it through AWS CloudFormation.
Expand All @@ -12,8 +14,6 @@ You can read more about it in the [aws-cdk README](https://github.com/aws/aws-cd

## Architecture

Read more about constructs, patterns and other architectural decisions in [docs](docs)

### Patterns

Patterns are high level classes which compose a number of constructs to produce standard architectures. For example, you should be able to get all of the resources you need to deploy a new lambda function from one `GuLambdaStack` class. We're still working on these right now but hope to start bringing you
Expand All @@ -27,6 +27,14 @@ Constructs are lower level classes which will create one or more resources to pr

If there is a pattern available for your use case, prefer to use that over composing constructs yourself. We welcome feedback and/or PRs to extend the functionality of patterns. Where you need to do something outside of currently available patterns, you can use the constructs to provide some level of abstraction. In this case, consider whether it's worth defining a pattern.

## Decision Records

## Architecture

[Architecture Decisions Records](https://github.com/joelparkerhenderson/architecture_decision_record) are files where we can document the decisions we make around any form of structure, architecture or approach. By documenting them in this way, we can preserve the thought process behind all of the decisions whilst also laying out formally the preferences for all developers working on the library.

The [docs/architecture-decision-records directory](https://github.com/guardian/cdk/tree/main/docs/architecture-decision-records) contains the records for `@guardian/cdk`.

## Useful commands

We follow the [`script/task`](https://github.com/github/scripts-to-rule-them-all) pattern,
Expand Down

0 comments on commit 95e3d78

Please sign in to comment.