Skip to content

Commit

Permalink
Merge pull request #494 from omahs/patch-1
Browse files Browse the repository at this point in the history
Fix typos in documentation
  • Loading branch information
danuw committed Apr 10, 2024
2 parents 10104a2 + 85d113b commit 5921f99
Show file tree
Hide file tree
Showing 6 changed files with 13 additions and 13 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ By knowing the carbon emissions of the energy that powers your applications, you
* Running software updates at greener energy time windows
* Using data to run hypothetical models to understand how you could start driving impact and reduce emissions, drive business cases for change, and create a greener future.

Within the [Green Software Foundations Theory of Change](https://greensoftware.foundation/articles/theory-of-change), we look at 3 pillars, that being **Knowledge**, **Tech Culture**, and **Tooling** as focus areas to drive this change. The Carbon Aware SDK at it's core sits firmly in the **Tooling** pillar, and also supports the other pillars, providing **Knowledge** through emissions data to inform change, and being core enabler for the **Tech Culture** for building carbon aware software.
Within the [Green Software Foundations Theory of Change](https://greensoftware.foundation/articles/theory-of-change), we look at 3 pillars, that being **Knowledge**, **Tech Culture**, and **Tooling** as focus areas to drive this change. The Carbon Aware SDK at its core sits firmly in the **Tooling** pillar, and also supports the other pillars, providing **Knowledge** through emissions data to inform change, and being core enabler for the **Tech Culture** for building carbon aware software.

Companies including UBS and Vestas have already deployed the Carbon Aware SDK to build greener software, and you can too!

Expand Down Expand Up @@ -102,7 +102,7 @@ centralised management, auditability and traceability, and more.
The Carbon Aware SDK is a collaborative effort between companies around the
world, with the intention of providing a platform that everyone can use. This
means the API will be striving towards what solves the highest impact issues
with diverse perspectives from these organisation and contributors.
with diverse perspectives from these organisations and contributors.

### Standardization

Expand Down Expand Up @@ -151,7 +151,7 @@ capability.

### Aggregated Sources

A feature we have in the roadmap is the ability aggregate data sources across
A feature we have in the roadmap is the ability to aggregate data sources across
multiple providers. Different data providers have different levels of
granularity depending on region, and it may be that data provider A is preferred
in Japan, while data provider B is preferred in US regions.
Expand Down
2 changes: 1 addition & 1 deletion casdk-docs/docs/overview/adopters.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ sidebar_position: 7

# Carbon Aware SDK adopters

We're sharing adopters of the Carbon Aware SDK with public evidence, although we know many others are also using the Carbon Aware SDK to reduce the carbon footprint their software.
We're sharing adopters of the Carbon Aware SDK with public evidence, although we know many others are also using the Carbon Aware SDK to reduce the carbon footprint of their software.
If you're using the Carbon Aware SDK and can share evidence, we'd love to add you to this list.
Please reach out to [email protected] or send a pull request.

Expand Down
6 changes: 3 additions & 3 deletions casdk-docs/docs/overview/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,13 +22,13 @@ We have opportunities for both code and non code contributors. We're currently l

| Contribution Areas | Description |
|----------|----------|
|**Sample Creation** | These help adopters of the SDK learn how they can quick get started and build their own carbon aware solutions.|
|**Sample Creation** | These help adopters of the SDK learn how they can quickly get started and build their own carbon aware solutions.|
|**Documentation Updates** | The documentation always can be improved to make the Carbon Aware SDK more accessible to everyone. Guides, SDK and API document, and more! |
|**Video Content Creation (how to enable, demos etc)** | Quick videos help adopters undersatnd just how easy it is to get started in an easy to consume form.
|**Video Content Creation (how to enable, demos etc)** | Quick videos help adopters understand just how easy it is to get started in an easy to consume form.
|**Slide Deck Creation <br /> Available for presenter use, including real time video demo**| We get a lot of traction at conferences, and if we have a standard deck for anyone to present, it will enable those who might not be able to create a deck, but could easily present it, to also participate.

## How To Get Started
Introduce yourself on on our [discussions page](https://github.com/orgs/Green-Software-Foundation/discussions/65) and let us know where you think you can help.
Introduce yourself on our [discussions page](https://github.com/orgs/Green-Software-Foundation/discussions/65) and let us know where you think you can help.
Find the Project Key contacts in the [Confluence page](https://greensoftwarefoundation.atlassian.net/wiki/spaces/~612dd45e45cd76006a84071a/pages/17137665/Opensource+Carbon+Aware+SDK).

If you are a GSF member organisation employee, you should:
Expand Down
4 changes: 2 additions & 2 deletions casdk-docs/docs/overview/enablement.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ sidebar_position: 3

2. [How to Use Carbon Aware SDK](#2-how-to-use-carbon-aware-sdk)

2.1 [Pre-requisities](#21-pre-requisities)
2.1 [Pre-requisites](#21-pre-requisites)
* Data sources
* System requirement

Expand Down Expand Up @@ -67,7 +67,7 @@ we show some examples of the [use case](./adopters.md).

## 2. How to use Carbon Aware SDK?

### 2.1 Pre-requisities
### 2.1 Pre-requisites

#### Data sources

Expand Down
6 changes: 3 additions & 3 deletions casdk-docs/docs/overview/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ By knowing the carbon emissions of the energy that powers your applications, you
* Running software updates at greener energy time windows
* Using data to run hypothetical models to understand how you could start driving impact and reduce emissions, drive business cases for change, and create a greener future.

Within the [Green Software Foundations Theory of Change](https://greensoftware.foundation/articles/theory-of-change), we look at 3 pillars, that being **Knowledge**, **Tech Culture**, and **Tooling** as focus areas to drive this change. The Carbon Aware SDK at it's core sits firmly in the **Tooling** pillar, and also supports the other pillars, providing **Knowledge** through emissions data to inform change, and being core enabler for the **Tech Culture** for building carbon aware software.
Within the [Green Software Foundations Theory of Change](https://greensoftware.foundation/articles/theory-of-change), we look at 3 pillars, that being **Knowledge**, **Tech Culture**, and **Tooling** as focus areas to drive this change. The Carbon Aware SDK at its core sits firmly in the **Tooling** pillar, and also supports the other pillars, providing **Knowledge** through emissions data to inform change, and being core enabler for the **Tech Culture** for building carbon aware software.

Companies including UBS and Vestas have already deployed the Carbon Aware SDK to build greener software, and you can too!

Expand Down Expand Up @@ -102,7 +102,7 @@ centralised management, auditability and traceability, and more.
The Carbon Aware SDK is a collaborative effort between companies around the
world, with the intention of providing a platform that everyone can use. This
means the API will be striving towards what solves the highest impact issues
with diverse perspectives from these organisation and contributors.
with diverse perspectives from these organisations and contributors.

### Standardization

Expand Down Expand Up @@ -151,7 +151,7 @@ capability.

### Aggregated Sources

A feature we have in the roadmap is the ability aggregate data sources across
A feature we have in the roadmap is the ability to aggregate data sources across
multiple providers. Different data providers have different levels of
granularity depending on region, and it may be that data provider A is preferred
in Japan, while data provider B is preferred in US regions.
Expand Down
2 changes: 1 addition & 1 deletion casdk-docs/docs/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -404,7 +404,7 @@ installation and example usage.
3. Install the Python client library using
[`setuptools`](http://pypi.python.org/pypi/setuptools)):
`python setup.py install --user`
4. The library is now succesfully installed!
4. The library is now successfully installed!

There should be an example script in the `README` file, but this guide suggests
trying the following example first:
Expand Down

0 comments on commit 5921f99

Please sign in to comment.