feat: refactor ADR(s) to conform with MADR style #8
Conversation
initialize adr folder with log4brains
update README with how to use log4brains
refactor the ADR template to be compatible with the styel of MADR https://adr.github.io/madr/
ADR-1 is refactored to conform with MADR style
Add gitignore file with common ignoring for editor configs
ADR-2 is refactored to conform with MADR style
ADR-3 is refactored to conform with MADR style
ADR-5 is refactored to conform with MADR style. Misc style changes are introduced in this commit for all ADR(s).
When visualized via log4brains UI an index page is added to describe greenhouse ADR(s)
keeps file names in example in lowercase
|
@auhlig - Since the ADR(s) were moved from internal repository, I am missing timeline of the created ADR(s). Could you point me to the internal repository, if it exists? Then I can update the timeline of the ADR(s). Currently they all point to yesterday's date. |
abhijith-darshan
added
documentation
Add the missing repository and ref to checkout action
Adds creation date of ADR(s)
Adds Makefile to easily lint and create new ADR(s) and updates README for Makefile usage
…s/documentation into feat/refactor-adrs
|
|
||
| ### Team Sync during Deployment | ||
|
|
||
|  |
There was a problem hiding this comment.
This does not resolve properly when running
log4brains preview
as it tries to serve the image from ./assets
Not sure we can solve this and keep the image in the markdown intact?
There was a problem hiding this comment.
yes, one of the drawbacks...
In a deployed version we would need to copy the assets into .log4brains/out/l4b-static/ and in the markdown reference it as 
| This will automatically append the next index and `greenhouse` prefix for the ADR and create a new ADR file with the provided title. | ||
|
|
||
| > NOTE: You can also override the prefix by passing PREFIX=<greenhouse | cloudoperators | ...> | ||
|
|
There was a problem hiding this comment.
Start the webserver
log4brains provides the possibility to serve a web ui showcasing all ADRs in this directory.
Start the web ui from repository root directory as such:
log4brains previewThis will bring up an UI on localhost:4004
There was a problem hiding this comment.
I removed this due to the fact that tables in log4brains and images don't work well. Instead focusing on standardizing ADR(s) template.
These markdowns can be visualized way better in Hugo if we decide to merge the docs and adrs in one location or separately in something like MkDocs in the future.
This PR aims to follow open ADR standards by following the style of MADR backed by a tooling to easily initialize new ADR(s) with a pre-defined template. There is also the possibility of building a static site out of this and deploy it to GitHub Pages as well.
log4brainstooling to init new ADR(s) with a pre-defined templateMakefile Usage: