Skip to content

Commit 469fbf4

Browse files
Add translations link and divs
1 parent 0c0324b commit 469fbf4

File tree

1 file changed

+29
-7
lines changed

1 file changed

+29
-7
lines changed

README.md

+29-7
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
<!--
22
browser: architecture-decision-record
33
tracker: 2bd6622ec3beeeddd8ff55cf0ccf2efc
4-
version: 2.0.0
5-
updated: 2021-05-19T18:56:40Z
4+
version: 3.0.0
5+
updated: 2023-11-07T20:42:12Z
66
contact: Joel Parker Henderson (http://joelparkerhenderson.com)
77
options: commentable
88
-->
@@ -17,10 +17,10 @@ Contents:
1717
- [How to start using ADRs](#how-to-start-using-adrs)
1818
- [How to start using ADRs with tools](#how-to-start-using-adrs-with-tools)
1919
- [How to start using ADRs with git](#how-to-start-using-adrs-with-git)
20-
- [ADR file name conventions](#adr-file-name-conventions)
20+
- [File name conventions for ADRs](#file-name-conventions-for-adrs)
2121
- [Suggestions for writing good ADRs](#suggestions-for-writing-good-adrs)
2222
- [ADR example templates](#adr-example-templates)
23-
- [Teamwork advice](#teamwork-advice)
23+
- [Teamwork advice for ADRs](#teamwork-advice-for-adrs)
2424
- [For more information](#for-more-information)
2525

2626
Templates:
@@ -34,7 +34,7 @@ Templates:
3434
* [Decision record template using Planguage](locales/en/templates/decision-record-template-using-planguage/)
3535
* [Decision record template by Paulo Merson](https://github.com/pmerson/ADR-template)
3636
* [Decision record template by Olaf Zimmermann](https://medium.com/olzzio/y-statements-10eb07b5a177)
37-
* Translations: [cymraeg](locales/cy) • [español](locales/es)[français](locales/fr) • [한국어](locales/ko)
37+
* [Translations into more languages](locales/)
3838

3939
Examples:
4040

@@ -48,6 +48,10 @@ Examples:
4848
* [Timestamp format](locales/en/examples/timestamp-format/)
4949
* [Many more...](locales/en/examples/)
5050

51+
[Translations into more languages](locales/)
52+
53+
54+
<div class="include" data-path="locales/en/what-is-an-architecture-decision-record">
5155

5256
## What is an architecture decision record?
5357

@@ -75,6 +79,9 @@ Abbreviations:
7579

7680
* **ASR**: architecturally-significant requirement
7781

82+
</div>
83+
84+
<div class="include" data-path="locales/en/how-to-start-using-adrs">
7885

7986
## How to start using ADRs
8087

@@ -122,6 +129,9 @@ For more:
122129

123130
* The steps above are adopted from the Wikipedia entry on [Architectural Decision](https://en.wikipedia.org/wiki/Architectural_decision)
124131

132+
</div>
133+
134+
<div class="include" data-path="locales/en/how-to-start-using-adrs-with-tools">
125135

126136
## How to start using ADRs with tools
127137

@@ -137,6 +147,9 @@ For example:
137147

138148
* If you like using wikis, such as MediaWiki, then you can create an ADR wiki.
139149

150+
</div>
151+
152+
<div class="include" data-path="locales/en/how-to-start-using-ADRs-with-git">
140153

141154
## How to start using ADRs with git
142155

@@ -158,8 +171,11 @@ Write anything you want in the ADR. See the templates in this repository for ide
158171

159172
Commit the ADR to your git repo.
160173

174+
</div>
175+
176+
<div class="include" data-path="locales/en/file-name-conventions-for-adrs">
161177

162-
## ADR file name conventions
178+
## File name conventions for ADRs
163179

164180
If you choose to create your ADRs using typical text files, then you may want to come up with your own ADR file name convention.
165181

@@ -183,6 +199,9 @@ Our file name convention:
183199

184200
* The extension is markdown. This can be useful for easy formatting.
185201

202+
</div>
203+
204+
<div class="import" data-path="locales/en/suggestions-for-writing-good-adrs">
186205

187206
## Suggestions for writing good ADRs
188207

@@ -216,6 +235,7 @@ A new ADR may take the place of a previous ADR:
216235

217236
* When an AD is made that replaces or invalidates a previous ADR, then a new ADR should be created
218237

238+
</div>
219239

220240
## ADR example templates
221241

@@ -233,8 +253,9 @@ ADR example templates that we have collected on the net:
233253

234254
* [ADR template using Planguage](locales/en/templates/decision-record-template-using-planguage/) (more quality assurance oriented)
235255

256+
<div class="import" data-path="locales/en/teamwork-advice-for-adrs">
236257

237-
## Teamwork advice
258+
## Teamwork advice for ADRs
238259

239260
If you're considering using decision records with your team, then here's some advice that we've learned by working with many teams.
240261

@@ -244,6 +265,7 @@ Some teams much prefer the name "decisions" over the abbreviation "ADRs". When s
244265

245266
In theory, immutability is ideal. In practice, mutability has worked better for our teams. We insert the new info the existing ADR, with a date stamp, and a note that the info arrived after the decision. This kind of approach leads to a "living document" that we all can update. Typical updates are when we get information thanks to new teammates, or new offerings, or real-world results of our usages, or after-the-fact third-party changes such as vendor capabilties, pricing plans, license agreements, etc.
246267

268+
</div>
247269

248270
## For more information
249271

0 commit comments

Comments
 (0)