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

Update openchain-reference-training-slides-iso5230-version1.md #41

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

jacobdjwilson
Copy link
Contributor

Slide 54 "Identify and Track Open Source Usage" diagram implemented as Mermaid Chart - Sequence Diagram

Slide 54 "Identify and Track Open Source Usage" diagram implemented as Mermaid Chart - Sequence Diagram
Copy link
Contributor

@shanecoughlan shanecoughlan left a comment

Choose a reason for hiding this comment

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

@maxhbr did a large whitespace update which is causing a conflict with merge here. Working to address it and insert your new example enterprise process on slide 54. Nice work!

@shanecoughlan
Copy link
Contributor

Important code is:

Example Enterprise Process

 sequenceDiagram
     Incoming Open Source->>+ Outgoing Open Source and Mods: Identification
     Incoming Open Source->>+ Outgoing Open Source and Mods: Audit
     Incoming Open Source->>+ Outgoing Open Source and Mods: Resolve Issues
     Incoming Open Source->>+ Outgoing Open Source and Mods: Reviews
     Incoming Open Source->>+ Outgoing Open Source and Mods: Approvals
     Incoming Open Source->>+ Outgoing Open Source and Mods: Registration
     Incoming Open Source->>+ Outgoing Open Source and Mods: Notices
     Incoming Open Source->>+ Outgoing Open Source and Mods: Verifications
     Incoming Open Source->>+ Outgoing Open Source and Mods: Distribution
     Incoming Open Source->>+ Outgoing Open Source and Mods: Verifications
Loading

Closing this pull request and committing the code via GitHub Desktop to get around the conflict. Elegant? No. Work? Yes.

@shanecoughlan
Copy link
Contributor

INSANELY COOL DIAGRAM! @jacobdjwilson can you brief the list on how to do this amazing stuff?

shanecoughlan added a commit that referenced this pull request Mar 21, 2023
@jacobdjwilson
Copy link
Contributor Author

jacobdjwilson commented Mar 21, 2023

Yep, I briefly discussed this on the mailing list with Alberto in the thread "OpenChain Reference Training Slides now in MarkDown (Draft, needs work)"

This diagram was created using Mermaid and the source code can be found here in the live editor tool. This works natively with MarkDown within GitHub and should allow us to convert everything to a editable format such that we can perform PRs on specifics within a graph. For example if someone wants to suggest expanding Audit to include multiple phases such as Security and License they could make a recommendation directly inline with the MarkDown content and it would update the diagram live .The trade off is a lack of rich format ie. colors, complex shapes, etc.

@shanecoughlan
Copy link
Contributor

As noted here with your larger contribution on this topic, merging with mainline.

What do you think about the potential to lead a review of the reference training slides to replace all the diagrams with this method?

@shanecoughlan shanecoughlan reopened this Apr 13, 2023
Copy link
Contributor

@shanecoughlan shanecoughlan left a comment

Choose a reason for hiding this comment

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

Merging and re-closing the pull request to ensure we clear the queue ahead of the latest slide update

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

Successfully merging this pull request may close these issues.

2 participants