mirror of
https://github.com/SAP/jenkins-library.git
synced 2025-03-03 15:02:35 +02:00
36 lines
869 B
Markdown
36 lines
869 B
Markdown
# Architecture Decision Records
|
|
|
|
ADRs are automatically published to our Log4brains architecture knowledge base:
|
|
|
|
🔗 **<https://www.project-piper.io/adr>**
|
|
|
|
Please use this link to browse them.
|
|
|
|
## Development
|
|
|
|
If not already done, install Log4brains:
|
|
|
|
```bash
|
|
npm install -g log4brains
|
|
```
|
|
|
|
To preview the knowledge base locally, run:
|
|
|
|
```bash
|
|
log4brains preview
|
|
```
|
|
|
|
In preview mode, the Hot Reload feature is enabled: any change you make to a markdown file is applied live in the UI.
|
|
|
|
To create a new ADR interactively, run:
|
|
|
|
```bash
|
|
log4brains adr new
|
|
```
|
|
|
|
## More information
|
|
|
|
- [Log4brains documentation](https://github.com/thomvaill/log4brains/tree/master#readme)
|
|
- [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)
|
|
- [ADR GitHub organization](https://adr.github.io/)
|