OWASP / OWASP/DevSecOpsGuideline

Diagram as code

Open
#89 3 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

idea
Dominant language
Python
Stars
1.1k
Forks
262
PR merge metrics
No merged PRs in 30d

Description

Would there be a significant interest in moving toward diagram as code for the various schema in this repository?

I have used mermaid personally with significant success to either document workflow, git history and a few others common diagram.

It fosters diagram evolution given everything is "as code".

Not certain if they would render properly on the web but it does in GitHub markdown.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue names no files, tests, or entry points. Review the repository's existing schema diagrams and verify how Mermaid renders in GitHub Markdown; a concrete, agreed scope and acceptance criteria would be needed before implementation can be considered done.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.