You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: website/docs/01-overview.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -16,7 +16,7 @@ Modern applications are composed of many smaller pieces of software (components)
16
16
17
17
The impacts of software components also vary over time, so as well as understanding **which** components contribute most to the overall impacts, there is also a question of **when** they contribute the most.
18
18
19
-
Only through a granular analysis of the impacts of your software system can investments in reducing its impact be prioritized and verified. Measurement is the first and most crucial step in greening a software system, and the first step in that process with the [Impact Framework](./04-specification/impact-framework.md) is to create an[Graph](./04-specification/impact-graph.md).
19
+
Only through a granular analysis of the impacts of your software system can investments in reducing its impact be prioritized and verified. Measurement is the first and most crucial step in greening a software system, and the first step in that process with the [Impact Framework](./04-specification/impact-framework.md) is to create a[Graph](./04-specification/impact-graph.md).
Copy file name to clipboardExpand all lines: website/docs/03-Terminology.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -38,7 +38,7 @@ A [Graph](specification/graph.md) is made up of nodes, each node represents eith
38
38
### Component
39
39
40
40
**aka**: *component node*
41
-
A component is something that creates environmental impacts, for example a server, network traffic. If it creates and environmental impact it's called a component. They effectively form the leaf nodes of an[Graph](specification/graph.md). Each component has at least one [Model Plugin](specification/model-plugin.md) configured as well as some [Inputs](inputs.md). We pass the observations to the model plugin which interacts with a model to calculate the [Impact](Impact) for this component.
41
+
A component is something that creates environmental impacts, for example a server, network traffic. If it creates and environmental impact it's called a component. They effectively form the leaf nodes of a[Graph](specification/graph.md). Each component has at least one [Model Plugin](specification/model-plugin.md) configured as well as some [Inputs](inputs.md). We pass the observations to the model plugin which interacts with a model to calculate the [Impact](Impact) for this component.
Copy file name to clipboardExpand all lines: website/docs/04-specification/impl.md
+6-6
Original file line number
Diff line number
Diff line change
@@ -1,15 +1,15 @@
1
1
---
2
2
author: Asim Hussain (@jawache)
3
-
abstract: Describes the structure and purpose of Impact YAML, a file format to represent an Impact Graph.
3
+
abstract: Describes the structure and purpose of Impact YAML, a file format to represent a Graph.
4
4
---
5
5
# Impl (Impact YAML)
6
6
7
-
- Impact YAML (IMPL) is a file format based on [yaml](https://circleci.com/blog/what-is-yaml-a-beginner-s-guide/) to represent an [Impact Graph](graph.md).
8
-
- Just like an Impact Graph, an IMPL is a calculation manifest containing everything you want to measure and how you want to measure it.
7
+
- Impact YAML (IMPL) is a file format based on [yaml](https://circleci.com/blog/what-is-yaml-a-beginner-s-guide/) to represent a [Graph](graph.md).
8
+
- Just like a Graph, an IMPL is a calculation manifest containing everything you want to measure and how you want to measure it.
9
9
- IMPL being YAML means it's more human-readable and can be used as a **formal method of writing use cases**, such as SCI use cases.
10
10
- IMPL files can be named `.yaml` (or `.impl`).
11
11
- IMPLs can be computed on the command line using the [Impact](Impact.md) tool, printing out the results to file or STDOUT.
12
-
- You can do much more using the [Impact Graph](graph.md) SDK directly; however, for many use cases, IMPL works fine.
12
+
- You can do much more using the [Graph](graph.md) SDK directly; however, for many use cases, IMPL works fine.
13
13
14
14
## Use Cases
15
15
@@ -29,8 +29,8 @@ The command line tool [Impact](Impact.md) can compute an IMPL file and generate
29
29
30
30
### To bootstrap code
31
31
32
-
- IMPLs will be able to represent simple calculation manifest but to handle larger, more complex systems, we will have to write Impact Graphs as code using our SDK.
33
-
- To help bootstrap the process, humans can write the high-level structure using IMPL and run through a tool to generate starter Impact Graph code in any language our SDK supports.
32
+
- IMPLs will be able to represent simple calculation manifest but to handle larger, more complex systems, we will have to write Graphs as code using our SDK.
33
+
- To help bootstrap the process, humans can write the high-level structure using IMPL and run through a tool to generate starter Graph code in any language our SDK supports.
Copy file name to clipboardExpand all lines: website/docs/04-specification/inputs.md
+3-3
Original file line number
Diff line number
Diff line change
@@ -1,11 +1,11 @@
1
1
---
2
2
author: Asim Hussain (@jawache)
3
-
abstract: Describes an input in the context of an Impact Graph.
3
+
abstract: Describes an input in the context of a Graph.
4
4
---
5
5
6
6
# Inputs
7
7
8
-
`inputs` are a core component of an [Impact Graph](graph.md) (graph), and they form the primary input into an [Impact Model Plugin](Impact%20Model%20Plugin.md) (model).
8
+
`inputs` are a core component of a [Graph](graph.md) (graph), and they form the primary input into an [Impact Model Plugin](Impact%20Model%20Plugin.md) (model).
9
9
10
10
An **input** is something you measure regarding a component in your software system. For example, an `input` about a server might be CPU utilization. `inputs` are passed into models which generate impact metrics.
11
11
@@ -75,7 +75,7 @@ As discussed in the [Granularity](Granularity.md) design document, an essential
75
75
76
76
One dimension of granularity is time, and `inputs` are how we provide that temporal granularity.
77
77
78
-
You can provide one single `input` for a long duration for every component in an [Impact Graph](graph.md); however, this won't give you a view of how the impacts changed over time.
78
+
You can provide one single `input` for a long duration for every component in a [Graph](graph.md); however, this won't give you a view of how the impacts changed over time.
79
79
80
80
This is why `inputs` are a time series; the more inputs you can provide about components over time, the more the Impact Framework can surface impacts over time.
Copy file name to clipboardExpand all lines: website/docs/04-specification/model-plugin.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@ abstract: Standardising the interface to measurement models.
4
4
---
5
5
# Model Plugin
6
6
7
-
Calculating outputs for every component in an [Impact Graph](graph.md) (graph) requires the use of an **Impact Model** (model) called through an [Impact Model Plugin](Impact%20Model%20Plugin.md) (model plugin).
7
+
Calculating outputs for every component in a [Graph](graph.md) (graph) requires the use of an **Impact Model** (model) called through an [Impact Model Plugin](Impact%20Model%20Plugin.md) (model plugin).
0 commit comments