dotnet-adr icon indicating copy to clipboard operation
dotnet-adr copied to clipboard

Implemented a simplified gitops way to manage ADRs

Open daneel3001 opened this issue 1 year ago • 1 comments

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

daneel3001 avatar May 13 '24 08:05 daneel3001

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.

HowardvanRooijen avatar May 15 '24 14:05 HowardvanRooijen