architecture_decision_record
backstage
architecture_decision_record | backstage | |
---|---|---|
22 | 125 | |
11,204 | 26,383 | |
- | 1.4% | |
7.7 | 10.0 | |
30 days ago | about 21 hours ago | |
TypeScript | ||
- | Apache License 2.0 |
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.
architecture_decision_record
-
Ask HN: How to Translate Markdown Repositories?
I'm translating the Architecture Decision Record project to more languages. I'm seeking advice and guidance please: how are you all managing translations of git repos of content such as documentation and markdown files?
My experiments so far are here:
https://github.com/sixarm/locale-help
My work-in-progress is to create a top level directory `./locales`, then subdirectories per language using a ISO 639-1 two-letter language code, then content directories, for example:
./locales/en/hello/ (this is in English)
./locales/es/hola/ (this is in Español a.k.a. Spanish)
What do you use to track which content directories correspond to each other across languages?
The Architecture Decision Record repo is now mostly auto-translated into Spanish, French, Welsh, and Korean, in the top level directory `./locales`, using the program `slug-case` to help translate the markdown content file headlines into directory names:
https://github.com/joelparkerhenderson/architecture-decision-record
-
Show HN: Architecture Decision Record – Spanish Tranlsations
Link is https://github.com/joelparkerhenderson/architecture-decision...
-
Architecture diagrams enable better conversations
Hi, article author here, we supplement our architecture diagrams with Architectural Decision Records (ADRs) https://github.com/joelparkerhenderson/architecture-decision... in the ADR we capture:
-
Documenting your decisions using the ADR approach
Architecture decision record by joelparkerhenderson
-
Polar v1.0: Let’s Fix Open Source Funding
If anyone wants to see Polar in action on a GitHub issue, I'm experimenting with Polar on my Architecture Decision Record repo:
https://github.com/joelparkerhenderson/architecture-decision...
(I'm on the fence about the value of Polar for this kind of issue... see what you think)
-
How did you acquire confidence in system design?
This method is only slightly formalized as ADR (architecture decision record). What I personally like about templates that people share on the interned (https://github.com/joelparkerhenderson/architecture-decision-record) it that if force designed to actually consider cons of selected approach or honestly attempt to analyze alternatives.
-
A practical overview on Architecture Decision Records (ADR)
The GitHub repo joelparkerhenderson/architecture-decision-record is a good source to get an overview of tools, articles and examples.
-
Ask HN: How to do Git successors, in case of death?
GitHub is prompting me to add a git successor to my open source repo, in case I die.
Do people here have advice about how to do this, or experience in doing it?
Any brainstorms about how to do it across all the related repos, orgs, etc., such as a will, or well-known file in the repo, that donates to a nonprofit, or foundation, etc.?
Here's the repo:
https://github.com/joelparkerhenderson/architecture-decision-record
-
A Simple Framework for Architectural Decisions
Architecture Decision Records are a big help for teamwork. I have a bunch of notes and examples here, including from my time at ThoughtWorks with technology radars.
https://github.com/joelparkerhenderson/architecture-decision...
-
Documenting agreements
If you want to get started with ADR, I recommend looking at the repository, where you can find different ADR templates and examples of how to use them.
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
-
APIMatic SDKs in Backstage Developer Portal
Backstage is an open-source platform developed by Spotify for managing the entire lifecycle of developer infrastructure, including services, APIs, documentation, and more. Backstage streamlines the development process through its centralized and customizable platform, offering a unified dashboard that consolidates information on projects, services, and infrastructure. Acting as a service catalog enhances transparency by allowing teams to document and discover internal services easily. Backstage's extensible architecture supports a robust plugin ecosystem, enabling teams to tailor the platform to their specific workflows and preferences. The platform promotes collaboration, accelerates onboarding through standardized documentation, and integrates seamlessly with various DevOps tools.
-
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.
[0] https://backstage.io/
-
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]
- Backstage: An open platform for building developer portals
-
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
-
Developer productivity for fun and profit - Part 2
The idea is to have a central point where people can find standards, documentation, and designs. The team can do this with a specialized tool like Backstage, Confluence, Github, Google Docs, or some internal implementation. The software is not the most important thing here, but having an easy way to find what is needed for the person to be more productive.
What are some alternatives?
oasis-core - Performant and Confidentiality-Preserving Smart Contracts + Blockchains
cookiecutter - A cross-platform command-line utility that creates projects from cookiecutters (project templates), e.g. Python package projects, C projects.
danger-js - ⚠️ Stop saying "you forgot to …" in code review
atlantis - Terraform Pull Request Automation
arc42.org-site - (jekyll-based) website for arc42.org - the template for communicating software architectures.
api-management-developer-portal - Developer portal provided by the Azure API Management service.
rfcs - Specifications for Interledger and related protocols
C4-PlantUML - C4-PlantUML combines the benefits of PlantUML and the C4 model for providing a simple way of describing and communicate software architectures
architecture-decision
gitops-flux-helm
log4brains - ✍️ Log and publish your architecture decisions (ADR)
Clutch - Fast iOS executable dumper