Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
@architect/docs
Advanced tools
@architect/docs - npm Package Compare versions
Comparing version 30.0.9 to 30.0.10
@@ -20,3 +20,4 @@ # Community | ||
| - Come chat with us in [Slack](https://join.slack.com/t/architecture-as-text/shared_invite/MjE2MzU4Nzg0NTY1LTE1MDA2NzgyMzYtODE2NzRkOGRmYw) | ||
| - Use the issue trackers above to file bugs, request features or even just to ask a question: nbd! | ||
| - Use the issue trackers above to file bugs, request features or even just to ask a question: nbd! | ||
| - If you don't know where to file the issue just add it to [arc.codes](https://github.com/arc-repos/arc.codes/issues) tracker | ||
@@ -37,2 +38,2 @@ ## Helping Out | ||
| Naming things is hard. `architect` started out as `arc` which itself was an acronym for `amazon run commands`. But mostly we just call it `arc` anyhow. The code was developed for and then extracted from begin.com and granted to JS Foundation in July of 2017 under the `Apache-2.0` license. | ||
| Naming things is hard. `architect` started out as `arc` which itself was an acronym for `amazon run commands`. But mostly we just call it `arc`. The code was developed building https://begin.com and granted to JS Foundation in July of 2017 under the `Apache-2.0` license. |
| # Concepts | ||
| `architect` guiding design principles: | ||
| Cloud functions surface unique problems. | ||
| - Architecture as text | ||
| - Repeatable and consistent builds | ||
| - Delivery isolated from deployment | ||
| - Extensible and flexibile systems | ||
| ## New Tech for New Problems | ||
| With all the benefits of cloud functions comes new and unique problems. | ||
| - Configuration tooling was designed for the last generation of metaphors (and lags behind the releases of new functionality) | ||
@@ -106,13 +97,30 @@ - AWS is massive and overwhelming with many similar, but not the same, products | ||
| ## Practices | ||
| ## Implementing Principles and Practices | ||
| Revisiting the `architect` design principles: | ||
| `architect` practice follows many of the principles pioneered by agile and championed by devops. We know its a good idea to version our infrastructure. We know we need tight feedback loops for dev. We need isolation between our development stages. And most of all we need our systems to be transparent and exensible. | ||
| - **Architecture as text** `.arc` manifest file defines achitecture element in the plainest text possible | ||
| - **Repeatable and consistent builds** `arc-create` only creates, it never destroys, and skips if the thing it was to generate already exists | ||
| - **Delivery isolated from deployment** `arc-sandbox` allows you to working locally offline from the cloud; meanwhile `arc-deploy` treats `staging` and `production` as first class concepts | ||
| - **Extensible and flexibile systems** `arc-parser` is open, and `architect` tooling ignores `@sections` it does not know, therefore use `.arc` with your own npm scripts; `arc-modules` lets you act on all `.arc` defined modules with common `npm` commands | ||
| ### Architecture as Text | ||
| - `.arc` manifest file defines achitecture element in the plainest text possible | ||
| - Nesting is deliberately constrained | ||
| ### Repeatable and Consistent Builds | ||
| - `arc-create` only creates, it never destroys, and skips if the thing it was to generate already exists | ||
| - Per above, `arc-create` is intended to be run and rerun as you system changes and grows | ||
| - Use the AWS console to admin (remove infrastructure) or script that yourself; architect never destroys | ||
| ### Delivery is isolated from Deployment | ||
| - `arc-sandbox` allows you to working locally offline from the cloud | ||
| - `arc-deploy` treats `staging` and `production` as first class concepts | ||
| ### Extensible and Flexibile Systems | ||
| - `arc-parser` is open, and `architect` tooling ignores `@sections` it does not know | ||
| - Therefore use `.arc` with your own npm scripts | ||
| - `arc-modules` lets you act on all `.arc` defined modules with common `npm` commands | ||
| ## Next Steps | ||
| Read about `.arc` [limitations](/intro/limits) next. | ||
| These principles and the practices that follow them are just a starting point; expect our understanding to grow and change as we learn more. Read about `.arc` [limitations](/intro/limits) next. |
@@ -47,2 +47,1 @@ # Project Layout | ||
| - Read up on how lambda functions are authored in the [reference](/reference) | ||
| - Skip the reference and check out code [examples](/examples) |
| { | ||
| "name": "@architect/docs", | ||
| "version": "30.0.9", | ||
| "version": "30.0.10", | ||
| "main": "index", | ||
@@ -5,0 +5,0 @@ "scripts": { |
No alert changes
Improved metrics
- Total package byte prevSize
- increased by0.9%
55220
No dependency changes