Skip to content

Commit 4808910

Browse files
committed
Refine documentation on branches
1 parent 5b62454 commit 4808910

File tree

2 files changed

+12
-10
lines changed

2 files changed

+12
-10
lines changed

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,8 @@ Longer explanation: Head to <https://adr.github.io/madr/#applying-madr-to-your-p
3939
| `develop` | Latest developments, including homepage updates which should be published on a release. `gh-pages` should always be merged into this branch. |
4040
| `release/vY` | Branch for latest release Y.x version of MADR. Introduced to fix [#92](https://github.com/adr/madr/issues/92) |
4141

42+
The branch name conventions follow the [git flow model](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow).
43+
4244
See also [`CONTRIBUTING.md`](CONTRIBUTING.md).
4345

4446
## How to start Jekyll locally

docs/index.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ MADR is a streamlined template for recording architectural significant decisions
3737
* 2022-11-22. MADR Version 1.0 was released five years ago. A new blog post ["The Markdown ADR (MADR) Template Explained and Distilled"](https://medium.com/olzzio/the-markdown-adr-madr-template-explained-and-distilled-b67603ec95bb) is available on Medium.
3838
* 2022-10-09: Release of MADR 3.0.0.\
3939
The most important change is the merged of sections "Positive Consequences" and "Negative Consequences" into "Consequences" to enable similar grammar as in "Pros and Cons of the Options".
40-
[[Full Changelog](https://github.com/adr/madr/blob/main/CHANGELOG.md#300--2022-10-09)]
40+
[[Full Changelog](https://github.com/adr/madr/blob/develop/CHANGELOG.md#300--2022-10-09)]
4141
* 2022-05-17: Release of MADR 3.0.0-beta.\
4242
Besides improvement of the template, there was a renaming from "Markdown Architectural Decision Records" to "Markdown Any Decision Records" to follow the movement ["ADR = Any Decision Record? Architecture, Design and Beyond"](https://ozimmer.ch/practices/2021/04/23/AnyDecisionRecords.html).
4343
The acronym is still MADR.
@@ -88,11 +88,11 @@ Chosen option: "Plain JUnit5", because it is a standard framework and the featur
8888

8989
For more examples see [examples](examples.md).
9090
For the MADR project itself, all ADRs are rendered at [decisions/](decisions/).
91-
Their source can be found at <https://github.com/adr/madr/tree/main/docs/decisions>.
91+
Their source can be found at <https://github.com/adr/madr/tree/develop/docs/decisions>.
9292
The latest release of the full template (with placeholders and some guidance how to use) can be found at the [releases page](https://github.com/adr/madr/releases/latest).
9393
By clicking on the number at the tag symbol, you browse the repository at the state of the release.
94-
For the brave, the version under development is available at <https://github.com/adr/madr/blob/main/template/adr-template.md>.
95-
There also is a [CHANGELOG](https://github.com/adr/madr/blob/main/CHANGELOG.md#changelog) listing the changes between the last released version and the currently developed version.
94+
For the brave, the version under development is available at <https://github.com/adr/madr/blob/develop/template/adr-template.md>.
95+
There also is a [CHANGELOG](https://github.com/adr/madr/blob/develop/CHANGELOG.md#changelog) listing the changes between the last released version and the currently developed version.
9696

9797
## Applying MADR to your project
9898

@@ -111,7 +111,7 @@ npm install madr && mkdir -p docs/decisions && cp node_modules/madr/template/* d
111111

112112
#### Manual approach
113113

114-
1. Copy [`docs/decisions/adr-template.md`](https://github.com/adr/madr/blob/main/template/adr-template.md) to `docs/decisions/NNNN-title-with-dashes.md`, where `NNNN` indicates the next number in sequence.
114+
1. Copy [`docs/decisions/adr-template.md`](https://github.com/adr/madr/blob/develop/template/adr-template.md) to `docs/decisions/NNNN-title-with-dashes.md`, where `NNNN` indicates the next number in sequence.
115115
2. Edit `NNNN-title-with-dashes.md`.
116116

117117
Note you can also use [other patterns for the directory format](https://github.com/joelparkerhenderson/architecture_decision_record#adr-file-name-conventions).
@@ -175,11 +175,11 @@ The current development version renders as follows:
175175

176176
## Older versions
177177

178-
| Version | Branch | Homepage |
179-
| -- | -- | -- |
180-
| 1.x | [release/v1](https://github.com/adr/madr/tree/release/v1) | [README.md](https://github.com/adr/madr/blob/release/v1/README.md) |
181-
| 2.x | [release/v2](https://github.com/adr/madr/tree/release/v2) | [README.md](https://github.com/adr/madr/blob/release/v2/README.md) |
182-
| 3.x | [release/v3](https://github.com/adr/madr/tree/release/v3) | [index.md](https://github.com/adr/madr/blob/release/v3/docs/index.md) |
178+
| Version | Branch | Homepage |
179+
|---------|-----------------------------------------------------------|-----------------------------------------------------------------------|
180+
| 1.x | [release/v1](https://github.com/adr/madr/tree/release/v1) | [README.md](https://github.com/adr/madr/blob/release/v1/README.md) |
181+
| 2.x | [release/v2](https://github.com/adr/madr/tree/release/v2) | [README.md](https://github.com/adr/madr/blob/release/v2/README.md) |
182+
| 3.x | [release/v3](https://github.com/adr/madr/tree/release/v3) | [index.md](https://github.com/adr/madr/blob/release/v3/docs/index.md) |
183183

184184
The branch name conventions follow the [git flow model](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow).
185185

0 commit comments

Comments
 (0)