backstage
mermaid
Our great sponsors
backstage | mermaid | |
---|---|---|
125 | 121 | |
26,255 | 66,684 | |
2.1% | 1.9% | |
10.0 | 10.0 | |
about 15 hours ago | 3 days ago | |
TypeScript | JavaScript | |
Apache License 2.0 | 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.
backstage
-
# Enable Developers on SAP BTP with Terraform, GitHub Actions and Backstage
apiVersion: scaffolder.backstage.io/v1beta3 # https://backstage.io/docs/features/software-catalog/descriptor-format#kind-template kind: Template metadata: name: sample-btpsubaccount-remote-template title: Remote Template for SAP BTP Subaccount Setup description: A remote template that creates a basic SAP BTP Subaccount setup tags: - sap - btp - basic - javascript spec: owner: user:guest type: service
-
The 2024 Web Hosting Report
It’s also well understood that having a k8s cluster is not enough to make developers able to host their services - you need a devops team to work with them, using tools like delivery pipelines, Helm, kustomize, infra as code, service mesh, ingress, secrets management, key management - the list goes on! Developer Portals like Backstage, Port and Cortex have started to emerge to help manage some of this complexity.
-
Ask HN: How do you organize software documentation at work?
We use Confluence and markdown files in GitHub. I think we are moving a lot of our docs to Backstage [0] soon.
One process that ends up being really valuable for documentation purposes is our "Architecture Review Documents". This is a standard document that team leads fill out before starting work on a new Saga/Epic/Feature/whatever. It includes the scope and business value of a new feature or large block of work, high level technical architecture of implementation, the impact on existing database schemas and service APIs, etc. This document is presented in a meeting with technical leadership in our organization who deep dive on the topic and explore potential pitfalls in the plan.
The document and recording of that meeting live on forever, and this information is very useful when getting acquainted with a certain part of our product/codebase. You are able to read and hear clearly the intention of a certain service or module, and you can identify several relevant points of contact to ask questions to.
-
Tools used by the top 1% of Platform Engineers and their Commercial Open Source Alternatives
Check the Backstage repo on GitHub
-
10 open source tools that platform, SRE and DevOps engineers should consider in 2024.
Backstage - An open platform for building developer portals. [Internal Developer Portal]
-
Champion Building - How to successfully adopt a developer tool
So you've just bought a new platform tool? Maybe it's Hashicorp Vault? Snyk? Backstage? You’re excited about all of the developer experience, security and other benefits you're about to unleash on your company—right? But wait…
- Terraform Self-Service platform / Internal Developer Platform solutions
-
Event-Driven Architecture 101
For example, without investment, visibility into system behavior as a whole can be much more difficult in an event-driven system. Investing in something like Open Telemetry and a service catalog is a good idea. Getting started with these things are relatively simple, but if you want to store your traces somewhere that are searchable, you are going to have to either pay for a SaaS tool that ingests them or you are going to have to run and maintain an open source tool capable of this such as Jaeger. For service cataloging, Backstage is becoming a very popular option. Depending on the capabilities and the capacity of your engineering team, this might be a good option and many companies do have platform teams that provide tooling such as this. With the average salary of a platform Engineer being ~$144k, companies should think carefully on whether the benefits of an EDA are going to outweigh the cost. We will dig deeper into this in part 2 and 3 of the series.
-
Tips and tricks for Backstage Software Templates
I'm a big fan of Backstage.
-
Happy and Productive Engineers with Backstage
There are already a number of vendors providing IDP solutions, but we know that our industry is mainly fueled by community efforts. It's no different with IDPs - there's a great OSS project that has become the de-facto industry standard for creating a portal! I'm talking about Backstage - the framework for building delivery (developer) portals. It was created at Spotify to improve the collaboration inside the engineering department and then open-sourced - so now we all can benefit from it!
mermaid
-
ChatCraft Adventures #13, UI Changes
This is an Issue I opened up for a potential feature. A couple weeks ago, I added nomnoml support to ChatCraft. ChatCraft renders previews for Mermaid and Nomnoml.
-
ChatCraft Adventures #10
Currently, ChatCraft supports Mermaid rendering. This feature request involves adding support for nomnoml rendering. Nomnoml is similar to Mermaid, in that they're both used in generating uml diagrams.
- Ask HN: Anyone use a code to mindmap/flowchart tool?
-
Show HN: Marimo – an open-source reactive notebook for Python
Marimo looks and feels great!
Have you considered adding support for mermaid.js in the markdown? I tried including some mermaid.js in a `mo.md` invocation, but it didn't render the diagram :-)
-
Penrose – Penrose
This feels like the LaTeX version of Mermaid.js [0]. I can do anything with it, but I gotta learn a lot of new syntax. So, really cool! Gonna have to dig into this.
- What website frameworks are used to build these websites?
-
Top 6 tools for text-based UML sequence diagrams
Mermaid is a Javascript-based diagramming tool for rendering many diagram types from Markdown-inspired text definitions and supports sequence diagrams. Mermaid is free and open-source under the MIT license.
-
The Unreasonable Effectiveness of Sequence Diagrams in MermaidJS
I'm one of the maintainers of the mermaid-cli project, and unfortunately, no.
Mermaid needs a browser's layout engine to run properly [1], but I haven't yet seen a library that will help us without puppeteer.
And yep, NPM (or another Node.JS package manager) is still needed for installation. I was working on trying to bundle all of mermaid-cli's dependencies (aka Node.JS, puppeteer) into one massive single-file exe last weekend, but it's seems we're blocked by missing features in other packages [2].
If anyone has any ideas on how to implement these things easily, feel free to help-out :) I'm also not a big fan of puppeteer, so I'd love to see a way to go without it.
[1]: https://github.com/mermaid-js/mermaid/issues/3650
[2]: https://github.com/mermaid-js/mermaid-cli/issues/467#issueco...
-
How to Write a Great Readme
I like using mermaid diagrams [1] in readme files and docs.
They're easier to read than plain text explanations for architectural layouts/customer journeys but easier to modify than images and GIFs.
Also natively supported in many flavours of markdown like Gitlab.
-
Creating Better API Architecture Diagrams
UML is just one format for diagram design specifications. Another option is to use a code to diagram tool like Mermaid. Mermaid transforms plain-text (Markdown inspired text definitions in this case) into full-fleshed visual diagrams. Their tool is open-source and written in JavaScript, making it easy to customize if you’re so inclined. Advantages include:
What are some alternatives?
plantuml - Generate diagrams from textual description
C4-PlantUML - C4-PlantUML combines the benefits of PlantUML and the C4 model for providing a simple way of describing and communicate software architectures
aws-icons-for-plantuml - PlantUML sprites, macros, and other includes for Amazon Web Services services and resources
draw.io - draw.io is a JavaScript, client-side editor for general diagramming.
d2 - D2 is a modern diagram scripting language that turns text to diagrams.
excalidraw - Virtual whiteboard for sketching hand-drawn like diagrams
graphviz
cookiecutter - A cross-platform command-line utility that creates projects from cookiecutters (project templates), e.g. Python package projects, C projects.
Graphviz - Simple Python interface for Graphviz
atlantis - Terraform Pull Request Automation
api-management-developer-portal - Developer portal provided by the Azure API Management service.
GoJS, a JavaScript Library for HTML Diagrams - JavaScript diagramming library for interactive flowcharts, org charts, design tools, planning tools, visual languages.