Skip to content

Commit 1c57172

Browse files
committed
docs: make this more of story that puts the value first
1 parent 1478792 commit 1c57172

File tree

2 files changed

+29
-34
lines changed

2 files changed

+29
-34
lines changed

ARCHITECTURE.md

Lines changed: 27 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -29,42 +29,12 @@ Rather than for speed, they need optimization for success.
2929
Secondly, by short _cycle times_ which is the amount of time it takes for a commit to be shipped to a production environment.
3030
Along this journey, we encounter our scope (more on it below):
3131

32-
- aspects of the _contribution_ environment;
32+
- aspects of the _development_ environment;
3333
- the packaging pipeline that produces artifacts;
3434
- and continuous processes integrating the application lifecycle.
3535

3636
The goal of Standard is to optimize the critical path along this journey to achieve superior _cycle times_ through the powers of Nix and Flakes over frameworks in failure mode of disregard for the intrinsic value of _reproducability_.
3737

38-
## Scope
39-
40-
The automatable sections of the SDLC end-to-end process can be subdivided (not broken up!) in roughly three process regions with different overall shapes and characteristics.
41-
42-
The stipulated process regions are:
43-
44-
- **Contribution Environment** which roughly covers _code-to-commit_.
45-
- **Packaging Pipeline** which roughly covers _commit-to-distribution_. It is typically set up once and then orchestrated by a CI control loop.
46-
- **Continuous 'X' within the Application Lifecycle Management** which roughly covers _distribution-to-next-rollout_.
47-
48-
> Glossary:
49-
>
50-
> We use the term _Contribution Environment_ to mean _Development Environment Plus_.
51-
> Compared to _Development Environment_, it explicitly encapsulates aspects of contribution and integration of the broader process flow.
52-
> If you prefer, you can think of _Development Environment_ for practical purposes.
53-
54-
While Standard is fundamentally concerned with optimizing across the end-to-end process, we also limit the scope inside this project repository for practical reasons:
55-
56-
Therefore, we seek to delegate the **Contribution Environment** to a trusted project with an appropriate scope in the broader Nix Community, while employing community outreach to try to ensure our optimization targets are met or at least not accidentally sabotaged.
57-
58-
On the other hand, we seek to delegate **Continuous 'X'** by dovetailing and cultivating outreach with more appropriate initiatives of adjacent ecosystems.
59-
60-
## Ideals
61-
62-
The project is rooted deeply inside the Nix Ecosystem, but it strives to become a portal to make the powers of a store based reproducible packaging system readily available and palatable to colleagues and friends.
63-
64-
- _Use nix only where it is best suited_ — a Nix maximalist approach may be an innate condition to some of us, but trying to be a portal we deeply recognize and value other perspectives and don't dismiss them as ignorance.
65-
- _Disrupt where disruption is necessary_ — to our chagrin, the Nix ecosystem is quite a monotheistic silo. Therefore, we don't shy away from deviating from its widely accepted norms and standards when we feel that it furthers our goals.
66-
- _Look left, right, above and beyond_ — our end-to-end perspective commands us to actively seek and reach out to other projects and ecosystems to compose the best possible value chain.
67-
6838
## Goals
6939

7040
- _Complete_: Standard should make a complete offer for setting up and running the automatable sections of the SDLC.
@@ -80,7 +50,7 @@ We'll make use of a simple value matrix with simple sentiment scores:
8050
- :smile: &rarr; <i>"feels pretty good."</i>
8151
- :neutral_face: &rarr; <i>"whatever?!?"</i>
8252

83-
The X-Axis represents the three prototypical stakeholder roles, while the Y-Axis represents the broad value creation categories that we have identified.
53+
The X-axis represents the three prototypical stakeholder roles, while the Y-axis represents the broad value creation categories that we have identified.
8454

8555
| | Software Sponsor [Principal] | Provider of SDLC Automation [Agent] | Consumer of SDLC Automation [Agent] |
8656
| ------------------------------------------------ | :--------------------------: | :---------------------------------: | :---------------------------------: |
@@ -122,6 +92,31 @@ The main selling points of Standard are:
12292

12393
These points show how Standard can help adopters to improve their software delivery process, and how it can save them time, money and improve the quality of their software.
12494

95+
## Scope
96+
97+
The automatable sections of the SDLC end-to-end process can be subdivided (not broken up!) in roughly three process regions with different overall shapes and characteristics.
98+
99+
The stipulated process regions are:
100+
101+
- **Development Environment** which roughly covers _code-to-commit_.
102+
- **Packaging Pipeline** which roughly covers _commit-to-distribution_. It is typically set up once and then orchestrated by a CI control loop.
103+
- **Continuous Delivery and Beyond (Application Lifecycle Management)** which roughly covers _distribution-to-next-rollout_.
104+
105+
While Standard is fundamentally concerned with optimizing across the end-to-end process, we also limit the scope inside this project repository for practical reasons:
106+
107+
Therefore, we seek to delegate the **Development Environment** to a trusted project with an appropriate scope in the broader Nix Community, while employing community outreach to try to ensure our optimization targets are met or at least not accidentally sabotaged.
108+
109+
On the other hand, we seek to delegate **Continous Delivery and Beyond** by dovetailing and cultivating outreach with more appropriate initiatives of adjacent ecosystems.
110+
111+
## Ideals
112+
113+
The project aims to impove the SDLC by sensibly applying Nix' own superpowers and its ecoysystem's ingenuity to the problem.
114+
But it strives to become a portal to make the powers of a store based reproducible packaging system readily available and palatable to colleagues and friends.
115+
116+
- _Use nix only where it is best suited_ &mdash; a Nix maximalist approach may be an innate condition to some of us, but trying to be a portal we deeply recognize and value other perspectives and don't dismiss them as ignorance.
117+
- _Disrupt where disruption is necessary_ &mdash; to our chagrin, the Nix ecosystem is quite a monotheistic silo. Therefore, we don't shy away from deviating from its widely accepted norms and standards when we feel that it furthers our goals.
118+
- _Look left, right, above and beyond_ &mdash; our end-to-end perspective commands us to actively seek and reach out to other projects and ecosystems to compose the best possible value chain.
119+
125120
## Architecture
126121

127122
<div align="center">

ROADMAP.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,9 @@ the Setup Process is where adoption success or failure may be determined alongsi
2828

2929
As discussed in the [Architecture](./ARCHITECTURE.md) document, we roughly identify three regions with shifting characteristics alongside the SDLC:
3030

31-
- Contribution Environment Region
31+
- Development Environment Region
3232
- Build Pipeline Region (including CI control loops)
33-
- Continuous X Region of the ALM (including environment propagation rules, SecOps, infrastructure management and others)
33+
- Continuous Delivery and Beyond (Application Lifecycle Management)
3434

3535
##### Deliverable Types
3636

0 commit comments

Comments
 (0)