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.

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

Reference material #20

Closed
Sealjay opened this issue Jul 29, 2021 · 5 comments
Closed

Reference material #20

Sealjay opened this issue Jul 29, 2021 · 5 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@Sealjay
Copy link
Contributor

Sealjay commented Jul 29, 2021

@atg-abhishek talked about having a place to add additional reference and background material, like the background on fuel mix that @Henry-WattTime shared today.

That could be good, at least as reference material or external sources for new joiners to the GSF.

Do we have an appropriate place outside of the specification to reference this @seanmcilroy29 ? Maybe as an addendum to the dictionary, or as background to the way we work? Slack is great for ongoing discussions, but it might be worth being able to link to sources or material that informed our viewpoint.

@jawache
Copy link
Contributor

jawache commented Aug 1, 2021

There are two places on the spec for some types of references already, see: https://github.com/Green-Software-Foundation/software_carbon_intensity/blob/dev/Software_Carbon_Intensity/Software_Carbon_Intensity_Specification.md#references

  • Normative References - are like pre-reading, the things you MUST read and understand before you can understand the topics in this spec.
  • Informative References - are just generally related content to this content, you don't have to read them, but it can be useful.

@Sealjay
Copy link
Contributor Author

Sealjay commented Aug 1, 2021

I'd seen those, but they seemed a little sparse compared to what we saw on the call! I guess we just need to do the work of adding the information

@jawache
Copy link
Contributor

jawache commented Aug 2, 2021 via email

@atg-abhishek atg-abhishek added the documentation Improvements or additions to documentation label Aug 5, 2021
@atg-abhishek
Copy link
Member

Actually @Sealjay, I was discussing this with @seanmcilroy29 and suggested that we create a "Welcome / Beginner's Guide to Green Computing" that may sit outside as an FAQ document so that folks can quickly get caught up with major concepts that relate to sustainable computing. Thoughts @jawache ?

@atg-abhishek
Copy link
Member

Vaughn: The community WG would be a good candidate for housing the FAQ document.
@Henry-WattTime you might have some good resources to seed this FAQ document.

@atg-abhishek and @dtoakley to bring this up with the Community WG for next week's meeting.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

5 participants