Skip to content

Catch all repo for experimenting with diagrams as code

License

Notifications You must be signed in to change notification settings

dpsnowden/diagrams

Repository files navigation

Diagrams

Catch all repo for experimenting with diagrams as code. D2, Mermaid, Structurizr, Python Diagrams etc. It also serves as an inventory of diagrams describing various facets of IOOS/DMAC. See ioos.us ioos.noaa.gov and ioos.github.io. Where is the data and where does it need to go?

Tools

  • This is helpful to make VSCode snippets and templates

Mermaid

  • mermaid esp the VSCode and Obsidian plugins

Python Diagrams

C4 and Structurizr

C4 Cheatsheet

D2

Jekyll, Github Pages, and Github Actions

Basic site building on Github using Jekyll (locally first) and also figure out a basic git pull workflow for suggesting changes correctly. Components include:

Build and serve the site from the local project directory (from Jekyl quick start:

bundle exec jekyll serve

Topics

Global Telecommunications System

gts-workflow

GTS, the NOAA Telecomm Gateway, NDBC and all things operational within NOAA

High Frequency Radar

Most complete description of HFRNet is at ioos/hfrnet hfr-data-flow.d2 hfr-data-flow.svg

Unified Forecast System Coastal Application

UFS-Coastal

Profiling Gliders

IOOS DMAC

TODO: Populate this with existing drawio diagrams. Can these be moved into a repo? Just images or links to actual draw.io URLs?

License

This project is licensed under the Creative Commons-0 License - see the LICENSE file for details

References and TODO

Read this for an intro to Github Pages. Great article Least you need to know about Github pages

Generally get better at:

  • github-cli
  • More skill with VSCode as a development environment
  • Incorporating the C4 build process below into Github via actions
  • Figuring out a better local development workflow for VSCode preiews of workspace.dsl
  • Incorporating external markdown files into C4/Structurizr.
  • Using D2 as a way to develop less structured C4 diagrams to supplement (or mermaid? There are at least 2 existing mermaid plugins for VSCode)

About

Catch all repo for experimenting with diagrams as code

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published