search

OpenChain-Project / Reference-Material

This repository contains the reference material related to the OpenChain Project
Other
71 stars 56 forks source link

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

Open jacobdjwilson opened 1 year ago

jacobdjwilson commented 1 year ago

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

shanecoughlan commented 1 year ago

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

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

shanecoughlan commented 1 year ago

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

jacobdjwilson commented 1 year ago

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 commented 1 year ago

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?