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

Create gsf-projects-diagram.md #80

Merged
merged 2 commits into from
May 4, 2023
Merged

Create gsf-projects-diagram.md #80

merged 2 commits into from
May 4, 2023

Conversation

Oleg-Zhymolokhov
Copy link
Contributor

This PR adds a Mermaid.js markdown file with a code-driven Diagram of the main technical projects of the GSF

@Oleg-Zhymolokhov
Create gsf-projects-diagram.md
365eb6a 
Signed-off-by: Oleg-Zhymolokhov <[email protected]>
@Oleg-Zhymolokhov Oleg-Zhymolokhov added the documentation Improvements or additions to documentation label Apr 12, 2023
@Oleg-Zhymolokhov Oleg-Zhymolokhov self-assigned this Apr 12, 2023
@Oleg-Zhymolokhov Oleg-Zhymolokhov mentioned this pull request Apr 12, 2023
Closed
Sealjay
Sealjay approved these changes Apr 19, 2023
View reviewed changes
Copy link
Contributor

@Sealjay Sealjay left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me! It isn’t what I was originally thinking, I was originally thinking only of project listing and data passing, but this is better I think.

We may also need to show dependencies on projects like SCI and SCI-reporting.

@Sealjay
Copy link
Contributor

Sealjay commented Apr 19, 2023

@dtoakley @dtoakley-tw @seanmcilroy29 Ready for review in OSS WG with above comments.

Willmish
Willmish approved these changes Apr 19, 2023
View reviewed changes
Copy link
Contributor

@Willmish Willmish left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The diagram looks good - on CA SDK side, the interaction mechanisms might be modified in the future, as support for generated libraries for different languages get added.

See this comment for a WIP client consumption methods of the CA SDK: Green-Software-Foundation/carbon-aware-sdk#252 (comment)

@Willmish
Copy link
Contributor

Willmish commented Apr 19, 2023 •
edited
Loading

@danuw Can I get your further input on this?
(Maybe not adding more detail to it, but finalising the diagrams I linked out to in the comment above and adding them to the CA SDK documentation so the diagram in this PR can link out to them)

@dtoakley-tw
Copy link

Feedback from WG call: Is there a way to color code the boxes that are the actual projects (ontology, carbonci, sdk)?

@dtoakley-tw
Copy link

Agreed in WG: to be merged in once the color coding above is completed.

@dtoakley-tw
Copy link

Same update / status as last week: ready to merge in once the color coding is in place!

@seanmcilroy29 seanmcilroy29 mentioned this pull request May 3, 2023
Closed
15 tasks
@Oleg-Zhymolokhov
Update gsf-projects-diagram.md
fdde99a 
Added coloring for projects

Signed-off-by: Oleg-Zhymolokhov <[email protected]>
@Oleg-Zhymolokhov Oleg-Zhymolokhov merged commit e954c4c into main May 4, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Willmish Willmish Willmish approved these changes

@Sealjay Sealjay Sealjay approved these changes

@jawache jawache Awaiting requested review from jawache

Assignees

@Oleg-Zhymolokhov Oleg-Zhymolokhov

Labels
documentation Improvements or additions to documentation ready-for-merge
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@Oleg-Zhymolokhov @Sealjay @Willmish @dtoakley-tw