spekt8
C4-PlantUML
spekt8 | C4-PlantUML | |
---|---|---|
1 | 24 | |
715 | 6,072 | |
0.0% | 1.5% | |
0.0 | 6.9 | |
over 2 years ago | about 15 hours ago | |
JavaScript | PlantUML | |
MIT License | MIT License |
Stars - the number of stars that a project has on GitHub. Growth - month over month growth in stars.
Activity is a relative number indicating how actively a project is being developed. Recent commits have higher weight than older ones.
For example, an activity of 9.0 indicates that a project is amongst the top 10% of the most actively developed projects that we are tracking.
spekt8
-
Ask HN: Visualizing software designs, especially of large systems (if at all)?
In my experience it tends not to be done because there's an inevitable drift between the system as it actually operates and the relevant visualizations and diagrams. I have seen them used as a starting off point at times, although that's also been infrequent.
There is however a growing movement of being able to visualize how a system is functioning at various levels. XState/Statecharts are a good example (https://xstate.js.org/viz/). Another example in the Ops space would be https://github.com/spekt8/spekt8 for K8S. I work at Grafana and we're more or less trying to expose these things in ways that make sense. Our bread and butter is timeseries data but we're adding more in that regard (it's possible to build node graphs from running systems).
C4-PlantUML
-
Ask HN: Guidelines for making clear architecture diagrams
Third this. Don't look any further, just do it!
Also, PlantUML + C4 is like peanut butter & jelly:
https://github.com/plantuml-stdlib/C4-PlantUML
I'll gladly give up control of layout, and accept some ugliness, to never again have to worry about dragging boxes and arrows to be pixel-aligned, and then do it all over again when I add another box...
It looks like Mermaid has C4 support too:
https://mermaid.js.org/syntax/c4.html
-
Documentation as Code for Cloud - C4 Model & Structurizr
C4-PlantUML: Export your model as C4-PlantUML diagrams.
-
Which tools do you use to create diagrams?
PlantUML + C4 plugin;
-
Add quick sketches in emacs org mode
Yes. I use this all the time for software diagramming. With c4 model (https://github.com/plantuml-stdlib/C4-PlantUML) and AWS icons (https://github.com/awslabs/aws-icons-for-plantuml)
-
Architecture diagrams should be code
The C4 model (https://c4model.com/) is great for architecture diagrams. You can use different tools to generate them. Here are the ones I've been using:
- https://github.com/plantuml-stdlib/C4-PlantUML
- D2 language, open source alternative to PlantUML
- Keep your diagrams updated with continuous delivery
- What FOSS programs would you recommend for creating concept maps on Linux?
-
C4 model for system architecture design
3️⃣ Text-based diagramming- C4-PlantUML
-
Ask HN: Confluence Alternative(s) Supporting Markdown?
> onboarding docs
yes, they're don't changing frequently
> system design docs
yes - see C4-PlantUML[1]
> meeting notes
no, unless they're directly code related like ADRs [2,3].
Although one can abuse Github Issues + comments for this, in my opinion it's better to use modern SaaS tools for this, i.e. Loom, Descript, Linear.app, etc. - you can automate this process, e.g. transcribe the meeting's recording and add the issue/repo using Github Actions.
--
[1] https://github.com/plantuml-stdlib/C4-PlantUML
[2] https://adr.github.io/
[3] https://docs.aws.amazon.com/prescriptive-guidance/latest/arc...
What are some alternatives?
codebase-visualizer-action - Visualize your codebase during CI.
mermaid - Generation of diagrams like flowcharts or sequence diagrams from text in a similar manner as markdown
Pythonocc-nodes-for-Ryven - Pythonocc nodes for Ryven
d2 - D2 is a modern diagram scripting language that turns text to diagrams.
shotglass - Tools to visualize large code bases in different ways.
aws-icons-for-plantuml - PlantUML sprites, macros, and other includes for Amazon Web Services services and resources
jira-grafana-json-datasource - Connect Grafana to Jira cloud to retrieve metrics on your Jira issues.
Azure-PlantUML - PlantUML sprites, macros, and other includes for Azure services
depict - depict – share mental models better
backstage - Backstage is an open platform for building developer portals
openvpn-admin-plus - Docker-based web interface (with golang backend) for monitoring and admin of an OpenVPN TAP/TUN server setup with PiVPN or other OpenVPN server installations. This project has been renamed from pivpn-tap-web-ui, to reflect its new broader scope.
dsl - Structurizr DSL