Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Readme updates for clarity #459

Merged
merged 16 commits into from
Feb 11, 2024
Merged

Readme updates for clarity #459

merged 16 commits into from
Feb 11, 2024

Conversation

vaughanknight
Copy link
Contributor

Pull Request

Issue Number: #411

Summary

Updates to the readme file and some images.

Changes

  • Update to project readme file only
  • Added some images

Checklist

  • Local Tests Passing?
  • CICD and Pipeline Tests Passing?
  • Documentation Updates Made?
  • This is not a breaking change. If it is, please describe it below.

Are there API Changes?

No

Is this a breaking change?

No

Anything else?

No

Please follow
GitHub's suggested syntax
to link Pull Requests to Issues via keywords

This PR Closes #411

@vaughanknight
Copy link
Contributor Author

@Sophietn - Are you able to help me source high quality version of 2 of the images please Sophie?

@vaughanknight
Copy link
Contributor Author

image

These ones in the files directory need updating with better versions @Sophietn - I'm happy to push them to the repo if you can help me find them.

@vaughanknight
Copy link
Contributor Author

I should add, I'm manually updating the 2nd image, it doesn't have the circling of carbon aware

@danuw danuw added this to the Release 1.3 - Project Graduation milestone Feb 7, 2024
@danuw danuw added documentation Improvements or additions to documentation 1.3 Tracking the work towards release 1.3 labels Feb 7, 2024
@danuw
Copy link
Collaborator

danuw commented Feb 7, 2024

LGTM, just waiting for the images @Sophietn may be able to help with.

@Sophietn
Copy link
Contributor

Sophietn commented Feb 7, 2024 •
edited
Loading

Hi @vaughanknight @danuw, I'll reach out to our designer to see if we have high quality ones on record, or can remake. Will update you here once I know

@Sophietn
Copy link
Contributor

Sophietn commented Feb 7, 2024

Hi @vaughanknight,
I've spoken with @Jenya-design. They're happy to help. Couple of clarifying questions:

  • Where did you take those screenshots from?
  • Would you like any edits to the images?

@vaughanknight
Copy link
Contributor Author

Hi @vaughanknight, I've spoken with @Jenya-design. They're happy to help. Couple of clarifying questions:

  • Where did you take those screenshots from?
  • Would you like any edits to the images?

Screenshots were from the decks accessible from the gsf website and documents are stored in google docs
In one of the images I circled the Carbon Aware SDK ... sort of freehand vs a box or a circle. It would be awesome if I can get an edit with that on it. Otherwise no edits needed.

@vaughanknight
Copy link
Contributor Author

Media Kit was the location https://drive.google.com/drive/folders/1mC2YiR9cRfTe5h7p_-aCndTB0v0biWVq

@Jenya-design
Copy link

@vaughanknight @Sophietn
Please check the images attached, they're 1920x1080, is it ok for you?

Carbom Aware SDK_demand shaping

Media Kit assets_infographic 3-11

@vaughanknight
Copy link
Contributor Author

These are great @Jenya-design thanks!

@vaughanknight
Updated images
b4a7973 
Updates all images and compressed some images, cleaned up naming for the avif file.
@vaughanknight
More updates
d0a954a 
New images, and some updates to the copy after stepping away from it for a bit.
@vaughanknight
Updates with theory of change details
996d084 
Updates with theory of change details
@vaughanknight
Update README.md
648a1ce
@vaughanknight
More updates
581267c 
More updates
@vaughanknight
Added plcaeholder images
3c90f55 
Added plcaeholder images
@vaughanknight
Updated images
6c1514e 
Updates all images and compressed some images, cleaned up naming for the avif file.
@vaughanknight
More updates
0592710 
New images, and some updates to the copy after stepping away from it for a bit.
@vaughanknight
Updates with theory of change details
c59057c 
Updates with theory of change details
@vaughanknight
Minor updates, included adopters page link
0cec58f 
Minor updates, included adopters page link
@vaughanknight
Merge branch 'Readme' of https://github.com/Green-Software-Foundation…
6a0864a 
…/carbon-aware-sdk into Readme
@vaughanknight
Further updates to clean up merge duplication
028a179
@vaughanknight
Signed-off-by: Vaughan Knight <[email protected]>
336d52f 
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]>
@danuw
Copy link
Collaborator

danuw commented Feb 8, 2024

Awesome.
@vaughanknight is this ready to do please? add the ready for review / tag me to let me know so I can merge this please

@danuw danuw merged commit 859c86a into dev Feb 11, 2024
8 checks passed
@danuw danuw deleted the Readme branch February 13, 2024 01:50
@danuw danuw mentioned this pull request Feb 26, 2024
Merged
4 tasks
@vaughanknight vaughanknight mentioned this pull request Mar 6, 2024
Merged
6 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
1.3 Tracking the work towards release 1.3 documentation Improvements or additions to documentation
Projects
Carbon Aware SDK
Status: Done
Milestone
Release 1.3 - Project Graduation
Development

Successfully merging this pull request may close these issues.

Update documentation for Project overview (ReadMe)
4 participants
@vaughanknight @danuw @Sophietn @Jenya-design