Skip to content

Commit d225a2c

Browse files
committed
fix grammar an -> a
1 parent 7dfbd59 commit d225a2c

File tree

5 files changed

+12
-12
lines changed

5 files changed

+12
-12
lines changed

website/docs/01-overview.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Modern applications are composed of many smaller pieces of software (components)
1616

1717
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.
1818

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).
2020

2121
## Navigating these docs
2222

website/docs/03-Terminology.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ A [Graph](specification/graph.md) is made up of nodes, each node represents eith
3838
### Component
3939

4040
**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.
4242

4343
### Grouping
4444

website/docs/04-specification/impl.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
---
22
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.
44
---
55
# Impl (Impact YAML)
66

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.
99
- 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.
1010
- IMPL files can be named `.yaml` (or `.impl`).
1111
- 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.
1313

1414
## Use Cases
1515

@@ -29,8 +29,8 @@ The command line tool [Impact](Impact.md) can compute an IMPL file and generate
2929

3030
### To bootstrap code
3131

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.
3434

3535
## Structure
3636

website/docs/04-specification/inputs.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
---
22
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.
44
---
55

66
# Inputs
77

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).
99

1010
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.
1111

@@ -75,7 +75,7 @@ As discussed in the [Granularity](Granularity.md) design document, an essential
7575

7676
One dimension of granularity is time, and `inputs` are how we provide that temporal granularity.
7777

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.
7979

8080
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.
8181

website/docs/04-specification/model-plugin.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ abstract: Standardising the interface to measurement models.
44
---
55
# Model Plugin
66

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).
88

99
## What are Impact Models?
1010

0 commit comments

Comments
 (0)