Skip to content

Commit

Permalink
Release 1.3 - Graduation Release (#484)
Browse files Browse the repository at this point in the history
* doc initial set up using classic template and typescript - doc is currently copied into casdk-docs/docs to get live updates (copied and not moved so changes in main can be easily identified when rebasing once it all works)

* favicon

* reoganising first draft

* doc link fixes

* github pages pipelines to accomodate customisations

* Update WattTime registration link

Signed-off-by: Phil Huang <[email protected]>

* Create adopters.md

Signed-off-by: tkuramoto33 <[email protected]>

* Initial codespace branch and associated docs

* Add Vestas.

Signed-off-by: tkuramoto33 <[email protected]>

* Remove a hyphen for consistent appearance

Signed-off-by: tkuramoto33 <[email protected]>

* Create enablement.md

table of content


Signed-off-by: Rintaro Ikeda <[email protected]>

* link fix

* workflow update

* updated github action

* ensuring there is a yarn lock file

* removed working directory from setup node action

* trying to have the working directory at a higher level

* trying cache dependency path property

* dont break the build on broken links for now

* updated user

* removed user

* updated user to deploy pages

* draft of enablement.md

Signed-off-by: Rintaro Ikeda <[email protected]>

* Update containerization.md

Small typo ("arbon" => "Carbon")

Signed-off-by: Richard Jackson <[email protected]>

* github token permissions updated to ensure contents write

* workflows fixes

* Ensuring username was not needed

* Support location source setting in Helm chart

Signed-off-by: Yasumasa Suenaga <[email protected]>

* Update carbon-aware-cli.md

Fixes bugs with Linux scripts

Signed-off-by: JasonLuuk <[email protected]>

* Update overview.md

Change the net url inside the prerequisites, I think the sdk requires version 6.0 net instead of the latest 8.0, which can mislead users.

Signed-off-by: JasonLuuk <[email protected]>

* Update quickstart.md

Fix wrong links

Signed-off-by: JasonLuuk <[email protected]>

* verify azure function workflow not to trigger on casdk-docs changes only

* Link fixes (may be related to latest version now erroring)

* test doc file

* restoring username and email and removing the test file

* updated vs code extensions

* DCO Remediation Commit for Dan Benitah <[email protected]>

I, Dan Benitah <[email protected]>, hereby add my Signed-off-by to this commit: 44578f4
I, Dan Benitah <[email protected]>, hereby add my Signed-off-by to this commit: 3ae9a00

Signed-off-by: Dan Benitah <[email protected]>

* Update the description

Signed-off-by: tkuramoto33 <[email protected]>

* Update the description to mention pull requests

Signed-off-by: tkuramoto33 <[email protected]>

* Update README.md

* More updates

More updates

* Added plcaeholder images

Added plcaeholder images

* Create tests.md

test coverage  #413 

Signed-off-by: Dan Benitah <[email protected]>

* Updated images

Updates all images and compressed some images, cleaned up naming for the avif file.

* More updates

New images, and some updates to the copy after stepping away from it for a bit.

* Updates with theory of change details

Updates with theory of change details

* Update README.md

* More updates

More updates

* Added plcaeholder images

Added plcaeholder images

* Updated images

Updates all images and compressed some images, cleaned up naming for the avif file.

* More updates

New images, and some updates to the copy after stepping away from it for a bit.

* Updates with theory of change details

Updates with theory of change details

* Minor updates, included adopters page link

Minor updates, included adopters page link

* Further updates to clean up merge duplication

* Signed-off-by: Vaughan Knight <[email protected]>

DCO Remediation Commit for Vaughan Knight <[email protected]>

I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: da70ec4
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: 6be74ff
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: fe5cef9
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: b4a7973
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: d0a954a
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: 996d084
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: 648a1ce
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: 581267c
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: 3c90f55
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: 6c1514e
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: 0592710
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: c59057c
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: 0cec58f
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: 028a179

Signed-off-by: Vaughan Knight <[email protected]>

* blog posts - unpublished / placeholder posts currently sit in blog_preview sub folder

* annoucementBar #416 to include disclaimer as well as CarbonHack link

* CarbonHack24 Update to README.md

Signed-off-by: Dan Benitah <[email protected]>

* bold disclaimer / banner message

* ensuring samples get deployed as part of the docs too

* working directory correction for moving samples in docs deployment workflow

* normalisation of the workflow name to others

* latest docusaurus updates to check the latest workflow

* docusaurus broken links build warning + move all samples folder

* Update CONTRIBUTING.md

Signed-off-by: Sophie Trinder <[email protected]>

* Update CONTRIBUTING.md

Signed-off-by: Sophie Trinder <[email protected]>

* Update CHANGELOG.md

Signed-off-by: Dan Benitah <[email protected]>

* Update CHANGELOG.md with first draft release notes for 1.2

Signed-off-by: Dan Benitah <[email protected]>

* Update CHANGELOG.md

Signed-off-by: Dan Benitah <[email protected]>

* Update CHANGELOG.md

Updating release date

Signed-off-by: Dan Benitah <[email protected]>

* Update WattTime registration link

Signed-off-by: Phil Huang <[email protected]>

* Update containerization.md

Small typo ("arbon" => "Carbon")

Signed-off-by: Richard Jackson <[email protected]>

* Create adopters.md

Signed-off-by: tkuramoto33 <[email protected]>

* Add Vestas.

Signed-off-by: tkuramoto33 <[email protected]>

* Remove a hyphen for consistent appearance

Signed-off-by: tkuramoto33 <[email protected]>

* Update the description

Signed-off-by: tkuramoto33 <[email protected]>

* Update the description to mention pull requests

Signed-off-by: tkuramoto33 <[email protected]>

* Create enablement.md

table of content


Signed-off-by: Rintaro Ikeda <[email protected]>

* draft of enablement.md

Signed-off-by: Rintaro Ikeda <[email protected]>

* Update carbon-aware-cli.md

Fixes bugs with Linux scripts

Signed-off-by: JasonLuuk <[email protected]>

* Initial codespace branch and associated docs

* updated vs code extensions

* DCO Remediation Commit for Dan Benitah <[email protected]>

I, Dan Benitah <[email protected]>, hereby add my Signed-off-by to this commit: 44578f4
I, Dan Benitah <[email protected]>, hereby add my Signed-off-by to this commit: 3ae9a00

Signed-off-by: Dan Benitah <[email protected]>

* Update README.md

* More updates

More updates

* Added plcaeholder images

Added plcaeholder images

* Updated images

Updates all images and compressed some images, cleaned up naming for the avif file.

* More updates

New images, and some updates to the copy after stepping away from it for a bit.

* Updates with theory of change details

Updates with theory of change details

* Minor updates, included adopters page link

Minor updates, included adopters page link

* Update README.md

* More updates

More updates

* Added plcaeholder images

Added plcaeholder images

* Updated images

Updates all images and compressed some images, cleaned up naming for the avif file.

* More updates

New images, and some updates to the copy after stepping away from it for a bit.

* Updates with theory of change details

Updates with theory of change details

* Signed-off-by: Vaughan Knight <[email protected]>

DCO Remediation Commit for Vaughan Knight <[email protected]>

I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: da70ec4
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: 6be74ff
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: fe5cef9
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: b4a7973
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: d0a954a
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: 996d084
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: 648a1ce
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: 581267c
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: 3c90f55
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: 6c1514e
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: 0592710
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: c59057c
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: 0cec58f
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: 028a179

Signed-off-by: Vaughan Knight <[email protected]>

* Update tests.md

our current coverage is 74.6% so adjusting until we can improve

Signed-off-by: Dan Benitah <[email protected]>

* Update README.md

linking to the new banner

Signed-off-by: Dan Benitah <[email protected]>

* adding the banner image

Signed-off-by: Dan Benitah <[email protected]>

* Create SECURITY.md

* merge and bug fixes

* Qucikstart fix and overview link adjustment following move

* Up Helm chart version to 1.1.0

Signed-off-by: Yasumasa Suenaga <[email protected]>

* Signed-off-by: Vaughan Knight <[email protected]>

DCO Remediation Commit for Vaughan Knight <[email protected]>

I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: da70ec4
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: 6be74ff
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: fe5cef9
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: b4a7973
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: d0a954a
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: 996d084
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: 648a1ce
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: 581267c
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: 3c90f55
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: 6c1514e
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: 0592710
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: c59057c
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: 0cec58f
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: 028a179

Signed-off-by: Vaughan Knight <[email protected]>

* CarbonHack24 Update to README.md

Signed-off-by: Dan Benitah <[email protected]>

* Create tests.md

test coverage  #413

Signed-off-by: Dan Benitah <[email protected]>

* Update tests.md

our current coverage is 74.6% so adjusting until we can improve

Signed-off-by: Dan Benitah <[email protected]>

* Signed-off-by: Vaughan Knight <[email protected]>

DCO Remediation Commit for Vaughan Knight <[email protected]>

I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: da70ec4
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: 6be74ff
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: fe5cef9
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: b4a7973
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: d0a954a
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: 996d084
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: 648a1ce
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: 581267c
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: 3c90f55
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: 6c1514e
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: 0592710
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: c59057c
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: 0cec58f
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: 028a179

Signed-off-by: Vaughan Knight <[email protected]>

* blog updates

* DCO Remediation Commit for Dan Benitah <[email protected]>

I, Dan Benitah <[email protected]>, hereby add my Signed-off-by to this commit: 356ce09
I, Dan Benitah <[email protected]>, hereby add my Signed-off-by to this commit: 2c342a8
I, Dan Benitah <[email protected]>, hereby add my Signed-off-by to this commit: 04be596
I, Dan Benitah <[email protected]>, hereby add my Signed-off-by to this commit: c437b5b
I, Dan Benitah <[email protected]>, hereby add my Signed-off-by to this commit: 46958d9
I, Dan Benitah <[email protected]>, hereby add my Signed-off-by to this commit: 21a0e16
I, Dan Benitah <[email protected]>, hereby add my Signed-off-by to this commit: 8bbe72e
I, Dan Benitah <[email protected]>, hereby add my Signed-off-by to this commit: 62e2a95
I, Dan Benitah <[email protected]>, hereby add my Signed-off-by to this commit: 5183d73
I, Dan Benitah <[email protected]>, hereby add my Signed-off-by to this commit: 93267d6
I, Dan Benitah <[email protected]>, hereby add my Signed-off-by to this commit: ee8841c
I, Dan Benitah <[email protected]>, hereby add my Signed-off-by to this commit: 2d7b4dd
I, Dan Benitah <[email protected]>, hereby add my Signed-off-by to this commit: 68bbb2f
I, Dan Benitah <[email protected]>, hereby add my Signed-off-by to this commit: 735a515
I, Dan Benitah <[email protected]>, hereby add my Signed-off-by to this commit: a31b391
I, Dan Benitah <[email protected]>, hereby add my Signed-off-by to this commit: b7483b6
I, Dan Benitah <[email protected]>, hereby add my Signed-off-by to this commit: 4cece7b
I, Dan Benitah <[email protected]>, hereby add my Signed-off-by to this commit: 83f3073
I, Dan Benitah <[email protected]>, hereby add my Signed-off-by to this commit: 4799d7a
I, Dan Benitah <[email protected]>, hereby add my Signed-off-by to this commit: d2d823d
I, Dan Benitah <[email protected]>, hereby add my Signed-off-by to this commit: c3d832c
I, Dan Benitah <[email protected]>, hereby add my Signed-off-by to this commit: ec96b52
I, Dan Benitah <[email protected]>, hereby add my Signed-off-by to this commit: 9567c45
I, Dan Benitah <[email protected]>, hereby add my Signed-off-by to this commit: 4527514
I, Dan Benitah <[email protected]>, hereby add my Signed-off-by to this commit: ff729b0
I, Dan Benitah <[email protected]>, hereby add my Signed-off-by to this commit: 1bdd2ad
I, Dan Benitah <[email protected]>, hereby add my Signed-off-by to this commit: 012ca25
I, Dan Benitah <[email protected]>, hereby add my Signed-off-by to this commit: c7d4563
I, Dan Benitah <[email protected]>, hereby add my Signed-off-by to this commit: a51782f
I, Dan Benitah <[email protected]>, hereby add my Signed-off-by to this commit: cc15035
I, Dan Benitah <[email protected]>, hereby add my Signed-off-by to this commit: 3c62bd4
I, Dan Benitah <[email protected]>, hereby add my Signed-off-by to this commit: 590f262

Signed-off-by: Dan Benitah <[email protected]>

DCO Remediation Commit for danuw <[email protected]>

I, danuw <[email protected]>, hereby add my Signed-off-by to this commit: fbc602c
I, danuw <[email protected]>, hereby add my Signed-off-by to this commit: ac1432f
I, danuw <[email protected]>, hereby add my Signed-off-by to this commit: 8166cf2
I, danuw <[email protected]>, hereby add my Signed-off-by to this commit: 48f117e

Signed-off-by: danuw <[email protected]>

* DCO Remediation Commit for danuw <[email protected]>

I, danuw <[email protected]>, hereby add my Signed-off-by to this commit: fbc602c
I, danuw <[email protected]>, hereby add my Signed-off-by to this commit: ac1432f
I, danuw <[email protected]>, hereby add my Signed-off-by to this commit: 8166cf2
I, danuw <[email protected]>, hereby add my Signed-off-by to this commit: 48f117e

Signed-off-by: danuw <[email protected]>
Signed-off-by: Dan Benitah <[email protected]>

* Update baseURL docusaurus config

Signed-off-by: Osama Jandali <[email protected]>

* Update docusaurus.config.js

Signed-off-by: Osama Jandali <[email protected]>

* Revert changes 

Signed-off-by: Osama Jandali <[email protected]>

* Update domain from docusaurus

Signed-off-by: Osama Jandali <[email protected]>

* Update docusaurus.config.js

Signed-off-by: Osama Jandali <[email protected]>

* Create CNAME file

Signed-off-by: Osama Jandali <[email protected]>

* clean up for title

* Option to show the samples in the local docs using `nm run start-with-samples` . Will need deleting manually for now

* seo for the doc site

* docs fixes

* layout update for blogs

* Update SECURITY.md

Updated with @Willmish recommendations for the document which were lost in a comment 👍

* DCO Remediation Commit for Vaughan Knight <[email protected]>

I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: 2dc06f8

Signed-off-by: Vaughan Knight <[email protected]>

* Ensure pictures on the blog are correctly sized

* updated links to videos

* Update README.md

* Change "Withing" to "Within"

I'm genuinely unsure on what word this should be, possible "Using", but I'm sure it's not "Withing".

Signed-off-by: Richard Jackson <[email protected]>

* Update README.md

Two other typos
- programatically -> programmatically
- soruces -> sources

Signed-off-by: Richard Jackson <[email protected]>

* first draft of release 1.3 changelog

* Update README.md with updated link to overview

Signed-off-by: Dan Benitah <[email protected]>

* Fix overview URL in README

Signed-off-by: Szymon Duchniewicz <[email protected]>

* Update README.md

Update FAQ link for Carbon Hack

Signed-off-by: Russell Trow <[email protected]>

* Updates to the contribution documentation

Updates to the contribution documentation

* DCO Remediation Commit for Vaughan Knight <[email protected]>

I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: f267eba

Signed-off-by: Vaughan Knight <[email protected]>

* Readme as project overview in docs, disclaimer update for graduated project, and docs deploying pipeline updates

* DCO Remediation Commit for Vaughan Knight <[email protected]>

I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: bd7ad15
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: 693beed
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: 1d78756
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: a7bc0fc
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: 571e217
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: a07870f
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: 0314c47
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: 3af6f73
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: 932a665
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: 9f09493
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: 02ea4d6
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: 183a676
I, Vaughan Knight <[email protected]>, hereby add my Signed-off-by to this commit: 0481081

Signed-off-by: Vaughan Knight <[email protected]>

---------

Signed-off-by: Phil Huang <[email protected]>
Signed-off-by: tkuramoto33 <[email protected]>
Signed-off-by: Rintaro Ikeda <[email protected]>
Signed-off-by: Richard Jackson <[email protected]>
Signed-off-by: Yasumasa Suenaga <[email protected]>
Signed-off-by: JasonLuuk <[email protected]>
Signed-off-by: Dan Benitah <[email protected]>
Signed-off-by: Vaughan Knight <[email protected]>
Signed-off-by: Sophie Trinder <[email protected]>
Signed-off-by: danuw <[email protected]>
Signed-off-by: Osama Jandali <[email protected]>
Signed-off-by: Szymon Duchniewicz <[email protected]>
Signed-off-by: Russell Trow <[email protected]>
Co-authored-by: danuw <[email protected]>
Co-authored-by: Dan Benitah <[email protected]>
Co-authored-by: Phil Huang <[email protected]>
Co-authored-by: tkuramoto33 <[email protected]>
Co-authored-by: Rintaro Ikeda <[email protected]>
Co-authored-by: rinikeda <[email protected]>
Co-authored-by: Richard Jackson <[email protected]>
Co-authored-by: yasuenag <[email protected]>
Co-authored-by: JasonLuuk <[email protected]>
Co-authored-by: Szymon Duchniewicz <[email protected]>
Co-authored-by: Sophie Trinder <[email protected]>
Co-authored-by: Osama Jandali <[email protected]>
Co-authored-by: Szymon Duchniewicz <[email protected]>
Co-authored-by: Russell Trow <[email protected]>
  • Loading branch information
15 people authored Mar 6, 2024
1 parent f8c2b96 commit f264961
Show file tree
Hide file tree
Showing 120 changed files with 15,449 additions and 453 deletions.
24 changes: 21 additions & 3 deletions .devcontainer/devcontainer.json
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,13 @@
// Use 'appPort' to create a container with published ports. If the port isn't working, be sure
// your server accepts connections from all interfaces (0.0.0.0 or '*'), not just localhost.
// "appPort": [],
// Use 'forwardPorts' to make a list of ports inside the container available locally.
"forwardPorts": [5073],
// "portsAttributes": {
// "5073": {
// "protocol": "https"
// }
// },

// Uncomment the next line to run commands after the container is created.
// "postCreateCommand": "rustc --version",
Expand All @@ -26,8 +33,19 @@
// Uncomment the line below to mount your local usersecrets into the devcontainer from a Mac/Linux OS
// "mounts": [ "source=${localEnv:HOME}/.microsoft/usersecrets,target=/root/.microsoft/usersecrets,type=bind" ],


// Add the IDs of extensions you want installed when the container is created in the array below.
"extensions": [
"ms-dotnettools.csharp"
]
"customizations": {
"vscode": {
"extensions": [
"ms-vscode.vscode-node-azure-pack",
"GitHub.copilot",
"GitHub.vscode-github-actions",
"GitHub.copilot-chat",
"ms-dotnettools.vscode-dotnet-runtime",
"ms-dotnettools.csdevkit",
"ms-dotnetools.csharp"
]
}
}
}
File renamed without changes.
65 changes: 65 additions & 0 deletions .github/workflows/6-jekyll-gh-pages.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
# Sample workflow for building and deploying a Jekyll site to GitHub Pages
name: 6-Deploy docs to GitHub Pages

on:
# Runs on pushes targeting the default branch
push:
branches: ["dev", "docs/*"]
paths:
- 'casdk-docs/**'
- 'samples/**'
# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: write
pages: write
id-token: write

# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
group: "pages"
cancel-in-progress: false

jobs:
deploy:
name: Deploy docs to GitHub Pages
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/setup-node@v3
with:
node-version: 18

- name: Copy Files
run: |
# Moving the samples folder at build& deploy time of the docs so that it appears in the end result
cp -r ./samples/ ./casdk-docs/docs/
cp -r ./README.md ./casdk-docs/docs/overview/overview.md
cp -r ./CONTRIBUTING.md ./casdk-docs/docs/overview/contributing.md
working-directory: .

- name: Install dependencies
run: yarn install --frozen-lockfile
working-directory: ./casdk-docs
- name: Build website
run: yarn build
working-directory: ./casdk-docs

# Popular action to deploy to GitHub Pages:
# Docs: https://github.com/peaceiris/actions-gh-pages#%EF%B8%8F-docusaurus
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
# Build output to publish to the `gh-pages` branch:
publish_dir: ./casdk-docs/build
# The following lines assign commit authorship to the official
# GH-Actions bot for deploys to `gh-pages` branch:
# https://github.com/actions/checkout/issues/13#issuecomment-724415212
# The GH actions bot is used by default if you didn't specify the two fields.
# You can swap them out with your own user credentials.
user_name: github-actions[bot]
user_email: 41898282+github-actions[bot]@users.noreply.github.com
1 change: 1 addition & 0 deletions .github/workflows/verify-azure-function-with-packages.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ on:
- 'src/**'
- '.github/workflows/**'
- 'samples/azure/azure-function/**'
- '!casdk-docs/**'

env:
DOCKERFILE_PATH: samples/azure/azure-function/Dockerfile
Expand Down
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -33,3 +33,5 @@ src/data/location-sources/custom-azure-zones.json

# exclude artifacts on java-client example
samples/java-client/target

casdk-docs/docs/samples/*
48 changes: 48 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,54 @@

All notable changes to the Carbon Aware SDK will be documented in this file.

## [1.3.0] - 2024-02

### Added

- docs site at https://carbon-aware-sdk.greensoftware.foundation/
- [PR #464 Create SECURITY.md ](https://github.com/Green-Software-Foundation/carbon-aware-sdk/pull/464)
- [PR #461 CarbonHack24 Update to README.md ](https://github.com/Green-Software-Foundation/carbon-aware-sdk/pull/461)
- [PR #457 Features/codespaces quickstart ](https://github.com/Green-Software-Foundation/carbon-aware-sdk/pull/457)
- [PR #459 Readme updates for clarity ](https://github.com/Green-Software-Foundation/carbon-aware-sdk/pull/459)
- [PR #449 Support location source setting in Helm chart ](https://github.com/Green-Software-Foundation/carbon-aware-sdk/pull/449)
- [PR #431 Update documentation of Usefulness (adopters.md) ](https://github.com/Green-Software-Foundation/carbon-aware-sdk/pull/431)%
- [#416 Add disclaimer banner to any public-facing documentation (docusaurus webpage) ](https://github.com/Green-Software-Foundation/carbon-aware-s dk/issues/416)
- [#415 Update documentation of secureness (security.md) ](https://github.com/Green-Software-Foundation/carbon-aware-sdk/issues/415)
- [#414 Update documentation of Usefulness (adopters.md) ](https://github.com/Green-Software-Foundation/carbon-aware-sdk/issues/414)
- [#413 Update documentation for Test Coverage ](https://github.com/Green-Software-Foundation/carbon-aware-sdk/issues/413)
- [#412 Update documentation for End User Guide (enablement.md) ](https://github.com/Green-Software-Foundation/carbon-aware-sdk/issues/412)
- [#410 Update documentation for How to contribute (contributing.md ) ](https://github.com/Green-Software-Foundation/carbon-aware-sdk/issues/410)

### Fixed

- [#344 [Bug]: Fix and update doc deployment workflow ](https://github.com/Green-Software-Foundation/carbon-aware-sdk/issues/344)

### Changed

- [#411 Update documentation for Project overview (ReadMe) ](https://github.com/Green-Software-Foundation/carbon-aware-sdk/issues/411)
- [PR #454 Update quickstart.md ](https://github.com/Green-Software-Foundation/carbon-aware-sdk/pull/454)
- [PR #453 Update overview.md ](https://github.com/Green-Software-Foundation/carbon-aware-sdk/pull/453)

#### API

-

#### API Deployment

-

#### SDK

-


#### Other

-


For more details, checkout [https://github.com/Green-Software-Foundation/carbon-aware-sdk/issues/474](https://github.com/Green-Software-Foundation/carbon-aware-sdk/issues/474)

## [1.2.0] - 2024-01

### Added
Expand Down
16 changes: 9 additions & 7 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,15 @@ and the approved contribution process that members should follow.
- [Collaborating with the OSWG](#collaborating-with-the-opensource-working-group)

## Current Opportunities
We have opportunities for both code and non code contributors.
We have opportunities for both code and non code contributors. We're currently looking all contributions, with some areas of extra opportunity outlined in the table below.

We're currently looking for contributions in the following areas:
1. Sample Creation
2. Documentation Updates, including getting docusaurus up and running
3. Video Content Creation (how to enable, demos etc)
4. Slide Deck Creation, available for presenter use, including real time video demo

| 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.|
|**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.
|**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.
Expand Down Expand Up @@ -83,7 +85,7 @@ do **not** open an issue to request features.
3. PR to be submitted against the **DEV feature branch**
4. PR discussed with the WG. If agreed, the WG Chair will merge into **DEV
Feature branch**
![GSF Single-Trunk Based Branch Flow](/docs/images/single-trunk-branch.svg)
![GSF Single-Trunk Based Branch Flow](./images/readme/single-trunk-branch.svg)
5. See
[The Way we Work](https://github.com/Green-Software-Foundation/standards_wg/blob/main/the_way_we_work.md)
for futher details.
64 changes: 49 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,36 @@
---
sidebar_position: 2
---

# Carbon Aware SDK
Carbon aware software does more when it can leverage greener energy sources, and less when the energy CO2 emissions are higher.

The Carbon Aware SDK is a toolset to help you measure the carbon emissions of your software, in turn helping you **measure and reduce your software's carbon emissions**, and choose when and where you run your software to make it greener.

![Carbon Aware Software](./images/readme/carbon-aware-software.png)


By knowing the carbon emissions of the energy that powers your applications, you and your organisation can leverage greener energy sources to reduce your CO2 emissions by:

* Building AI models when carbon emissions are lower
* Deploying software into the cloud in locations that have greener energy sources
* 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.

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

# Getting Started Overview

Head on over to the [Getting Started Overview Guide](./casdk-docs/docs/overview/overview.md) to get up and running.

Get started on creating sustainable software innovation for a greener future
today!

![Green Software](./images/readme/what-is-green-software.avif)

# How Does This Work?
You can reduce the carbon footprint of your application by just running things
at different times and in different locations. That is because not all
electricity is produced in the same way. Most is produced through burning fossil
Expand All @@ -9,6 +40,8 @@ When software does more when the electricity is clean and do less when the
electricity is dirty, or runs in a location where the energy is cleaner, we call
this **carbon aware software**.

![Carbon Aware Software](./images/readme/types-of-green-software.png)

The Carbon Aware SDK helps you build the carbon aware software solutions with
the intelligence to use the greenest energy sources. Run them at the greenest
time, or in the greenest locations, or both! Capture consistent telemetry and
Expand All @@ -20,27 +53,22 @@ where energy is the greenest, and create tools that give insights and help
software innovators to make greener software decisions. All of this helps reduce
carbon emissions.

# Getting Started Overview

Head on over to the [Getting Started Overview Guide](./docs/overview.md) to get up and running.

Get started on creating sustainable software innovation for a greener future
today!

## What is the Carbon Aware SDK?

At its core the Carbon Aware SDK is a WebApi and Command Line Interface (CLI) to
assist in building carbon aware software. The functionality across the CLI and
WebApi is identical by design.

You can use these to attain carbon emissions data for the energy that powers your applications, and in turn programmatically make greener decisions in your software.

### The WebApi

The WebApi is the preferred deployment within large organisations to centralise
management and increase control and auditability, especially in regulated
environments. It can be deployed as a container for easy management, and can be
deployed alongside an application within a cluster or separately.

![WebApi Screenshot](./images/screenshot_web_api.png)
![WebApi Screenshot](./images/readme/screenshot_web_api.png)

### The CLI

Expand All @@ -49,18 +77,16 @@ where a command-line can be used. This tends to be common with legacy DevOps
pipelines to drive deployment for integration testing where you can test your
deployment in the greenest location.

![WebApi Screenshot](./images/screenshot_cli.png)
![WebApi Screenshot](./images/readme/screenshot_cli.png)

## Who Is Using the Carbon Aware SDK?

The Carbon Aware SDK is being used by large and small companies around the
world. Some of the world’s biggest enterprises and software companies, through
to start-ups.
to start-ups. Both UBS and Vestas have used the SDK, with further details over on the [adopters overview](./casdk-docs/docs/overview/adopters.md).

Machine Learning (ML) workloads are a great example of long running compute
intensive workloads, that often are also not time critical. By moving these
workloads to a different time, the carbon emissions from the ML training can be
reduced by up to 15%, and by moving the location of the training this can be
intensive workloads, that often are also not time critical. By moving these workloads to a different time, the carbon emissions from the ML training can be reduced by up to 15%, and by moving the location of the training this can be
reduced even further, at times by up to 50% or more.

## What does the SDK/API provide that 3rd party data providers such as WattTime or ElectricityMaps do not?
Expand Down Expand Up @@ -136,7 +162,7 @@ prefer to use for on premises workloads, which you can combine in aggregate with

## Is it possible to retrieve energy mix information from the SDK?

Energy mix (the percentages that are from different energy soruces i.e. coal,
Energy mix (the percentages that are from different energy sources i.e. coal,
nuclear, wind, gas, solar, tidal, hydro etc) is not provided in the API to date.
This may be a feature we will consider in the future. The SDK provides emissions
percentage information only at the moment.
Expand All @@ -153,9 +179,17 @@ The Carbon Aware SDK is a project as part of the
Open Source Working Group.

### Appointments
The following are those who are currently actively working on the SDK and have made significant ongoing contributions.

- Chair/Project lead - Vaughan Knight (Microsoft)
- Vice Chair - Szymon Duchniewicz (Avanade)
- Senior Technical Program Manager - Sophie Trinder (Green Software Foundation)
- Principal Contributor - Szymon Duchniewicz (Avanade)
- Principal Contributor - Dan Benitah (Avanade)
- Contributor - Bill DeRusha (Microsoft)
- Contributor - Yasumasa Suenaga (NTT Data)
- Contributor - Damien Roux (NTT Data)

Please note that there are many others who have made contributions over time - these are all greatly appreciated, the project would not be where it is today without everyone's support. Thank you.

### GSF Project Scope

Expand Down
Loading

0 comments on commit f264961

Please sign in to comment.