-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Deploying to gh-pages from @ 076e9e2 🚀
- Loading branch information
1 parent
abe231f
commit b05f8f6
Showing
21 changed files
with
24 additions
and
24 deletions.
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
1 change: 0 additions & 1 deletion
1
...ains/_next/data/9BvmmbPiUjFyGERn3-U8U/adr/20240410-use-log4brains-to-manage-the-adrs.json
This file was deleted.
Oops, something went wrong.
1 change: 0 additions & 1 deletion
1
.../data/9BvmmbPiUjFyGERn3-U8U/adr/20240410-use-markdown-architectural-decision-records.json
This file was deleted.
Oops, something went wrong.
1 change: 0 additions & 1 deletion
1
log4brains/_next/data/9BvmmbPiUjFyGERn3-U8U/adr/blog/20240410-astro-for-the-blog.json
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
1 change: 1 addition & 0 deletions
1
...ains/_next/data/tovRmb1buX-YKFHwJ_fhg/adr/20240410-use-log4brains-to-manage-the-adrs.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
{"pageProps":{"projectName":"Github Decision Records","currentAdr":{"slug":"20240410-use-log4brains-to-manage-the-adrs","package":null,"title":"Use Log4brains to manage the ADRs","status":"draft","supersededBy":null,"tags":["dev-tools","doc"],"deciders":[],"body":{"enhancedMdx":"\n## Context and Problem Statement\n\nWe want to record architectural decisions made in this project.\nWhich tool(s) should we use to manage these records?\n\n## Considered Options\n\n- [Log4brains](https://github.com/thomvaill/log4brains): architecture knowledge base (command-line + static site generator)\n- [ADR Tools](https://github.com/npryce/adr-tools): command-line to create ADRs\n- [ADR Tools Python](https://bitbucket.org/tinkerer_/adr-tools-python/src/master/): command-line to create ADRs\n- [adr-viewer](https://github.com/mrwilson/adr-viewer): static site generator\n- [adr-log](https://adr.github.io/adr-log/): command-line to create a TOC of ADRs\n\n## Decision Outcome\n\nChosen option: \"Log4brains\", because it includes the features of all the other tools, and even more.\n"},"creationDate":"2024-04-20T13:02:34.000Z","lastEditDate":"2024-04-21T11:43:32.000Z","lastEditAuthor":"WayneGoosen","publicationDate":"2024-04-09T21:59:59.000Z","file":{"relativePath":"docs/adr/20240410-use-log4brains-to-manage-the-adrs.md","absolutePath":"/home/runner/work/adr/adr/docs/adr/20240410-use-log4brains-to-manage-the-adrs.md"},"repository":{"provider":"github","viewUrl":"https://github.com/WayneGoosen/adr/blob/master/docs/adr/20240410-use-log4brains-to-manage-the-adrs.md"}},"l4bVersion":"1.0.1"},"__N_SSG":true} |
1 change: 1 addition & 0 deletions
1
.../data/tovRmb1buX-YKFHwJ_fhg/adr/20240410-use-markdown-architectural-decision-records.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
{"pageProps":{"projectName":"Github Decision Records","currentAdr":{"slug":"20240410-use-markdown-architectural-decision-records","package":null,"title":"Use Markdown Architectural Decision Records","status":"draft","supersededBy":null,"tags":["doc"],"deciders":[],"body":{"enhancedMdx":"\n## Context and Problem Statement\n\nWe want to record architectural decisions made in this project.\nWhich format and structure should these records follow?\n\n## Considered Options\n\n- [MADR](https://adr.github.io/madr/) 2.1.2 with Log4brains patch\n- [MADR](https://adr.github.io/madr/) 2.1.2 – The original Markdown Architectural Decision Records\n- [Michael Nygard's template](http://thinkrelevance.com/blog/2011/11/15/documenting-architecture-decisions) – The first incarnation of the term \"ADR\"\n- [Sustainable Architectural Decisions](https://www.infoq.com/articles/sustainable-architectural-design-decisions) – The Y-Statements\n- Other templates listed at <https://github.com/joelparkerhenderson/architecture_decision_record>\n- Formless – No conventions for file format and structure\n\n## Decision Outcome\n\nChosen option: \"MADR 2.1.2 with Log4brains patch\", because\n\n- Implicit assumptions should be made explicit.\n Design documentation is important to enable people understanding the decisions later on.\n See also [A rational design process: How and why to fake it](https://doi.org/10.1109/TSE.1986.6312940).\n- The MADR format is lean and fits our development style.\n- The MADR structure is comprehensible and facilitates usage & maintenance.\n- The MADR project is vivid.\n- Version 2.1.2 is the latest one available when starting to document ADRs.\n- The Log4brains patch adds more features, like tags.\n\nThe \"Log4brains patch\" performs the following modifications to the original template:\n\n- Change the ADR filenames format (`NNN-adr-name` becomes `YYYYMMDD-adr-name`), to avoid conflicts during Git merges.\n- Add a `draft` status, to enable collaborative writing.\n- Add a `Tags` field.\n\n## Links\n\n- Relates to <AdrLink slug=\"20240410-use-log4brains-to-manage-the-adrs\" status=\"draft\" title=\"Use Log4brains to manage the ADRs\" customLabel=\"Use Log4brains to manage the ADRs\" />\n"},"creationDate":"2024-04-20T13:02:34.000Z","lastEditDate":"2024-04-21T11:43:32.000Z","lastEditAuthor":"WayneGoosen","publicationDate":"2024-04-09T21:59:59.000Z","file":{"relativePath":"docs/adr/20240410-use-markdown-architectural-decision-records.md","absolutePath":"/home/runner/work/adr/adr/docs/adr/20240410-use-markdown-architectural-decision-records.md"},"repository":{"provider":"github","viewUrl":"https://github.com/WayneGoosen/adr/blob/master/docs/adr/20240410-use-markdown-architectural-decision-records.md"}},"l4bVersion":"1.0.1"},"__N_SSG":true} |
1 change: 1 addition & 0 deletions
1
log4brains/_next/data/tovRmb1buX-YKFHwJ_fhg/adr/blog/20240410-deploy-blog-using-astro.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
{"pageProps":{"projectName":"Github Decision Records","currentAdr":{"slug":"blog/20240410-deploy-blog-using-astro","package":"blog","title":"deploy blog using astro","status":"draft","supersededBy":null,"tags":["blog","<!--","[space","and/or","comma","separated","list","of","tags]","optional","-->"],"deciders":["Wayne Goosen [list everyone involved in the decision] <!-- optional -->"],"body":{"enhancedMdx":"\nTechnical Story: [description | ticket/issue URL] <!-- optional -->\n\n## Context and Problem Statement\n\nI need to identify a platform or technology for sharing blog content online. Which platform or technology is optimal for running my personal blog?\n\n## Decision Drivers <!-- optional -->\n\n- Ideally owning the platform\n- Inexpesnive\n- Good performance\n\n## Considered Options\n\n- Astro with github pages\n- Jeykll with github pages\n- Dev.to\n- Meduim\n\n## Decision Outcome\n\nChosen option: \"Astro with github pages\", because:\n- I can own the site and control all aspects.\n- Good website performance (lighthouse score).\n- Blog template available. Up and running quickly.\n- Free hosting with github pages.\n- A few well known individuals in the industry using Astro.\n\n## Links <!-- optional -->\n\n- [Blog template](https://github.com/danielcgilibert/blog-template) <!-- example: Refined by [xxx](yyyymmdd-xxx.md) -->\n- … <!-- numbers of links can vary -->\n"},"creationDate":"2024-04-21T11:43:32.000Z","lastEditDate":"2024-04-21T11:43:32.000Z","lastEditAuthor":"WayneGoosen","publicationDate":null,"file":{"relativePath":"packages/blog/docs/adr/20240410-deploy-blog-using-astro.md","absolutePath":"/home/runner/work/adr/adr/packages/blog/docs/adr/20240410-deploy-blog-using-astro.md"},"repository":{"provider":"github","viewUrl":"https://github.com/WayneGoosen/adr/blob/master/packages/blog/docs/adr/20240410-deploy-blog-using-astro.md"}},"l4bVersion":"1.0.1"},"__N_SSG":true} |
Oops, something went wrong.