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

Rendering system and component structure to a diagram #1743

Open
butler54 opened this issue Nov 4, 2024 · 2 comments
Open

Rendering system and component structure to a diagram #1743

butler54 opened this issue Nov 4, 2024 · 2 comments
Labels
Backlog enhancement New feature or request

Comments

@butler54
Copy link
Collaborator

butler54 commented Nov 4, 2024

Issue description / feature objectives

This is speculative for discussion

SSPs typically have a large number of diagrams. Today that would be supported by an external image reference. The defacto way that is suggested under trestle is to use drawio and check it in as code.

However, drawio files, while xml, are from a SCM management PoV binary blobs. This brings two issues:

  1. What "as code" image formats could be used.
  2. If required to generate images from the oscal model (for example to build a diagram of the components and sub-components in an SSP). what format could be used.

At a high level mermaid.js is proposed as:

  1. Support from major SCM makers (GitHub and GitLab) as an integrated extension of markdown
  2. Is focused on IT including support for some UML flavours
  3. Is not a drawing format. There are limited methods to manipulate the diagrams layout. While this might not be perfect for a sales deck.

Caveats / Assumptions

  • As code implies that it's declarative as well where possible (e.g. gitops over shell scripts in github)

Completion Criteria

  • An expermmental workflow showing how a mermaid diagram can be used in an SSP. Ideally with a word or pdf format output.
@jpower432
Copy link
Member

@butler54 I think this might be related to #1617. Wondering if this could be an issue under this Epic. What do you think?

@jpower432 jpower432 moved this from New to Waiting for feedback in Trestle Roadmap Nov 12, 2024
@jpower432 jpower432 added enhancement New feature or request Backlog labels Nov 12, 2024
@butler54
Copy link
Collaborator Author

butler54 commented Dec 5, 2024

@butler54 to provide some examples of mermaid

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Backlog enhancement New feature or request
Projects
Status: Waiting for feedback
Development

No branches or pull requests

2 participants