github.com/ouraigua/jenkins-library@v0.0.0-20231028010029-fbeaf2f3aa9b/documentation/adr/README.md (about)

     1  # Architecture Decision Records
     2  
     3  ADRs are automatically published to our Log4brains architecture knowledge base:
     4  
     5  🔗 **<https://www.project-piper.io/adr>**
     6  
     7  Please use this link to browse them.
     8  
     9  ## Development
    10  
    11  If not already done, install Log4brains:
    12  
    13  ```bash
    14  npm install -g log4brains
    15  ```
    16  
    17  To preview the knowledge base locally, run:
    18  
    19  ```bash
    20  log4brains preview
    21  ```
    22  
    23  In preview mode, the Hot Reload feature is enabled: any change you make to a markdown file is applied live in the UI.
    24  
    25  To create a new ADR interactively, run:
    26  
    27  ```bash
    28  log4brains adr new
    29  ```
    30  
    31  ## More information
    32  
    33  - [Log4brains documentation](https://github.com/thomvaill/log4brains/tree/master#readme)
    34  - [What is an ADR and why should you use them](https://github.com/thomvaill/log4brains/tree/master#-what-is-an-adr-and-why-should-you-use-them)
    35  - [ADR GitHub organization](https://adr.github.io/)