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

Consider transitioning all graphs from Visio to Mermaid #37

Open
3 tasks
Chris-Turner-NIST opened this issue Oct 9, 2019 · 1 comment
Open
3 tasks
Labels
Documentation The issue relates to improvements or modifications to general content, examples and figures. enhancement New feature or request
Projects

Comments

@Chris-Turner-NIST
Copy link
Collaborator

User Story:

Mermaid is a tool that can be used to visualize the Vulntology Graphs using text representations within GitHub. We may be able to leverage this tool to allow easier tracking of changing to any graphs and to easily reference portions of the graphs within other sections of the Vulntology documentation.

Goals:

Review Mermaid and determine whether or not this is a good direction to go.
Redo the Vulntology Graph within mermaid to ensure we can retain all the current complexity we feel is important to convey.

Dependencies:

N/A

Acceptance Criteria

  • All readme documentation affected by the changes in this issue have been updated.
  • A Pull Request (PR) is submitted that addresses the goals of this User Story. This issue is referenced in the PR. If the PR only partially addresses a given User Story, the specific goals addressed are identified in the PR.
  • All current graphs are updated using Mermaid and all informational items within specification section are updated to reflect the appropriate graph portion

{The items above are general acceptance criteria for all User Stories. Please describe anything else that must be completed for this issue to be considered resolved.}

@Chris-Turner-NIST Chris-Turner-NIST added the enhancement New feature or request label Oct 9, 2019
@david-waltermire david-waltermire added this to To do in Sprint 6 Feb 7, 2020
@Chris-Turner-NIST Chris-Turner-NIST added the Documentation The issue relates to improvements or modifications to general content, examples and figures. label Oct 23, 2023
@Crashedmind
Copy link

https://plantuml.com/ is a LOT more powerful and featureful than Mermaid (which is a pro and a con depending on what you're trying to do).
E.g. blocks or sections of diagrams can be defined in separate files and then included into other files/diagrams.

Main disadvantage is that it is not natively supported in Github - so the diagrams-as-text have to be rendered to images. Many Markdown tools support Plantuml so take care of this for you.

PlantUML also supports architecture/icon diagrams per https://crashedmind.github.io/PlantUMLHitchhikersGuide/
(Disclaimer: I wrote this guide)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation The issue relates to improvements or modifications to general content, examples and figures. enhancement New feature or request
Projects
No open projects
Sprint 6
  
To do
Development

No branches or pull requests

2 participants