Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Implemented a simplified gitops way to manage ADRs #228

Open
daneel3001 opened this issue May 13, 2024 · 1 comment
Open

Implemented a simplified gitops way to manage ADRs #228

daneel3001 opened this issue May 13, 2024 · 1 comment

Comments

@daneel3001
Copy link

Hello

New user of this very useful tool.
Were there discussions to facilitate collaboration through gitops ?

I see this could be useful:

  • Creation of a markdown page summarizing all of the ADRs grouped by status
  • Enable creation of ADRs across different folders with a folder representing a lifecycle status or a "domain"
  • Facilitate the above by implementing an index for the ADR repository which would you hold things like policies and unique identifiers
  • Generation of relative links when cross referencing ADRs
@HowardvanRooijen
Copy link
Member

I love all these ideas, and I'm kinda kicking myself that I didn't think of them myself.

I'm not entirely sure what you mean when you say "collaboration through GitOps" - but one of the core features of ADRs that we love is that they stay next to the code... which means if you're working on a new feature in a new branch, new / updated ADRs are also in that branch as part of the design / implementation process... once the PR is approved and merged in, the new ADRs are also merged in / updated and the state of the design documents continue to reflect the state of the solution.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants