Skip to content

Commit 72eab16

Browse files
filiphrfiliphr
committed
Use data format for the releases in the reference guide
1 parent d44f43c commit 72eab16

File tree

10 files changed

+90
-49
lines changed

10 files changed

+90
-49
lines changed

‎content/documentation/reference-guide.md‎

Lines changed: 1 addition & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -2,59 +2,11 @@
22
date = "2019-02-10T12:21:00+02:00"
33
draft = false
44
title = "Reference Guide"
5+
type = "releases"
56
weight = 200
67
teaser = "The reference documentation and API docs for the current stable and previous versions of MapStruct."
78

89
[menu]
910
[menu.main]
1011
parent = "Documentation"
1112
+++
12-
13-
**1.6.0.Beta1** (November 4th 2023; latest beta release)
14-
15-
* Reference guide: [HTML](/documentation/dev/reference/html/) | [PDF](/documentation/dev/reference/pdf/mapstruct-reference-guide.pdf)
16-
* API documentation: [JavaDoc](/documentation/dev/api/)
17-
* [Migration notes](https://github.com/mapstruct/mapstruct/releases/tag/1.6.0.Beta1)
18-
19-
20-
**1.5.5.Final** (April 23th 2023; latest stable release)
21-
22-
* Reference guide: [HTML](/documentation/stable/reference/html/) | [PDF](/documentation/stable/reference/pdf/mapstruct-reference-guide.pdf)
23-
* API documentation: [JavaDoc](/documentation/stable/api/)
24-
* [Migration notes](https://github.com/mapstruct/mapstruct/releases/tag/1.5.5.Final)
25-
26-
**Spring Extensions** (September 25th 2023; latest milestone release)
27-
28-
* Reference guide: [HTML](/documentation/spring-extensions/reference/html/)
29-
* API documentation: [Annotations JavaDoc](/documentation/spring-extensions/api/annotations/) | [Extensions JavaDoc](/documentation/spring-extensions/api/extensions/) | [Test Extensions JavaDoc](/documentation/spring-extensions/api/test-extensions/)
30-
31-
**1.4.2.Final** (January 31st 2021)
32-
33-
* Reference guide: [HTML](/documentation/1.4/reference/html/) | [PDF](/documentation/1.4/reference/pdf/mapstruct-reference-guide.pdf)
34-
* API documentation: [JavaDoc](/documentation/1.4/api/)
35-
* [Migration notes](https://github.com/mapstruct/mapstruct/releases/tag/1.4.2.Final)
36-
37-
**1.3.1.Final** (September 29th 2019)
38-
39-
* Reference guide: [HTML](/documentation/1.3/reference/html/) | [PDF](/documentation/1.3/reference/pdf/mapstruct-reference-guide.pdf)
40-
* API documentation: [JavaDoc](/documentation/1.3/api/)
41-
* [Migration notes](https://github.com/mapstruct/mapstruct/releases/tag/1.3.1.Final)
42-
43-
**1.2.0.Final** (October 18th 2017)
44-
45-
* Reference guide: [HTML](/documentation/1.2/reference/html/) | [PDF](/documentation/1.2/reference/pdf/mapstruct-reference-guide.pdf)
46-
* API documentation: [JavaDoc](/documentation/1.2/api/)
47-
* [Migration notes](https://github.com/mapstruct/mapstruct/releases/tag/1.2.0.Final)
48-
49-
50-
**1.1.0.Final** (November 18th 2016)
51-
52-
* Reference guide: [HTML](/documentation/1.1/reference/html/) | [PDF](/documentation/1.1/reference/pdf/mapstruct-reference-guide.pdf)
53-
* API documentation: [JavaDoc](/documentation/1.1/api/)
54-
* [Migration notes](https://github.com/mapstruct/mapstruct/wiki/Migration-notes#110final)
55-
56-
**1.0.0.Final** (November 25th 2015)
57-
58-
* Reference guide: [HTML](/documentation/1.0/reference/html/) | [PDF](/documentation/1.0/reference/pdf/mapstruct-reference-guide.pdf)
59-
* API documentation: [JavaDoc](/documentation/1.0/api/)
60-
* [Migration notes](https://github.com/mapstruct/mapstruct/wiki/Migration-notes#100final)

‎data/releases/1.0.toml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
name = "1.0.0.Final"
2+
versionRef = "1.0"
3+
order = 1
4+
releaseDate = 2015-11-25
5+
migrationNotesLink = "https://github.com/mapstruct/mapstruct/wiki/Migration-notes#100final"

‎data/releases/1.1.toml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
name = "1.1.0.Final"
2+
versionRef = "1.1"
3+
order = 2
4+
releaseDate = 2016-11-18
5+
migrationNotesLink = "https://github.com/mapstruct/mapstruct/wiki/Migration-notes#110final"

‎data/releases/1.2.toml‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
name = "1.2.0.Final"
2+
versionRef = "1.2"
3+
order = 3
4+
releaseDate = 2017-10-18

‎data/releases/1.3.toml‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
name = "1.3.1.Final"
2+
versionRef = "1.3"
3+
order = 4
4+
releaseDate = 2019-09-29

‎data/releases/1.4.toml‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
name = "1.4.2.Final"
2+
versionRef = "1.4"
3+
order = 5
4+
releaseDate = 2021-01-31

‎data/releases/1.5.toml‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
name = "1.5.5.Final"
2+
versionRef = "1.5"
3+
order = 500
4+
releaseDate = 2023-04-23

‎data/releases/1.6.toml‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
name = "1.6.0.Beta1"
2+
versionRef = "1.6"
3+
order = 1000
4+
releaseDate = 2023-11-04

‎data/releases/spring-extensions.toml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
name = "Spring Extensions"
2+
versionRef = "spring-extensions"
3+
order = 450
4+
releaseDate = 2023-09-25
5+
spring = true

‎layouts/releases/single.html‎

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
{{ define "main" }}
2+
<div>
3+
<div class="uk-flex uk-flex-space-between">
4+
<div>
5+
<h1>{{ .Title }}</h1>
6+
</div>
7+
<div class="uk-hidden-small uk-float-right ms-edit-on-github">
8+
{{ partial "edit_on_github.html" . }}
9+
</div>
10+
</div>
11+
</div>
12+
<div>{{ .Content }}</div>
13+
<div>
14+
{{ range sort $.Site.Data.releases "order" "desc" }}
15+
<p>
16+
<strong>{{ .name }}</strong>
17+
({{ time.Format "January" .releaseDate }} {{ humanize .releaseDate.Day }} {{ .releaseDate.Year }}{{ if eq $.Site.Params.stableVersion .name }}; latest stable release{{ else if eq $.Site.Params.devVersion .name }}; latest beta release{{ end }})
18+
</p>
19+
<ul>
20+
<li>Reference guide:
21+
<a href="/documentation/{{ .versionRef }}/reference/html/">HTML</a>
22+
{{ if not .spring }}| <a href="/documentation/{{ .versionRef }}/reference/pdf/">PDF</a>{{ end }}
23+
</li>
24+
<li>
25+
API documentation:
26+
{{ if .spring }}
27+
<a href="/documentation/spring-extensions/api/annotations/">Annotations JavaDoc</a> |
28+
<a href="/documentation/spring-extensions/api/extensions/">Extensions JavaDoc</a> |
29+
<a href="/documentation/spring-extensions/api/test-extensions/">Test Extensions JavaDoc</a>
30+
{{ else if .stable }}
31+
<a href="/documentation/stable/api/">JavaDoc</a>
32+
{{ else if .dev }}
33+
<a href="/documentation/dev/api/">JavaDoc</a>
34+
{{ else }}
35+
<a href="/documentation/{{ .versionRef }}/api/">JavaDoc</a>
36+
{{ end }}
37+
</li>
38+
{{ if .migrationNotesLink }}
39+
<li>
40+
<a href="{{ .migrationNotesLink }}">Migration notes</a>
41+
</li>
42+
{{ else if not .spring }}
43+
<li>
44+
<a href="https://github.com/mapstruct/mapstruct/releases/tag/{{ .name }}">Migration notes</a>
45+
</li>
46+
{{ end }}
47+
</ul>
48+
{{ end }}
49+
</div>
50+
{{ end }}
51+
52+
{{ define "aside" }}
53+
{{ partial "section_menu.html" . }}
54+
{{ end }}

0 commit comments

Comments
 (0)