@@ -6,12 +6,19 @@ The following list summarizes significant changes to the modular documentation s
6
6
For a complete list of changes, see link:https://github.com/redhat-documentation/modular-docs/pulls?q=is%3Apr+is%3Aclosed[the merged pull requests].
7
7
8
8
// Release notes template:
9
+ // [discrete]
9
10
// == <year>: <month>
10
11
//
11
12
// * <Brief description of change. Include an inline link to the relevant section of the guide.>
12
13
// link:<URL of the GitHub issue associated with this change>
13
14
15
+ [discrete]
16
+ == 2024: January
14
17
18
+ * Removed the `*[role="_abstract"]*` tag from the templates (regression).
19
+ link:https://github.com/redhat-documentation/modular-docs/pull/222[#222]
20
+
21
+ [discrete]
15
22
== 2023: December
16
23
17
24
* Added the *What's new* section to the Modular documentation reference guide.
@@ -20,31 +27,31 @@ link:https://github.com/redhat-documentation/modular-docs/pull/214[#214]
20
27
* Added references to the *link:https://redhat-documentation.github.io/supplementary-style-guide/#shortdesc[Short descriptions]* section in the Red Hat SSG to provide detailed guidelines for the introduction of an assembly or a module.
21
28
link:https://github.com/redhat-documentation/modular-docs/pull/216/[#216]
22
29
23
-
30
+ [discrete]
24
31
== 2023: September
25
32
26
33
* Added guidance for solving the problem when *both* your assembly and the last module included in that assembly contain an *Additional resources* section to the modular documentation assembly template.
27
34
link:https://github.com/redhat-documentation/modular-docs/pull/210[#210]
28
35
29
-
36
+ [discrete]
30
37
== 2023: August
31
38
32
39
* Updated the name of the *content type attribute* in the templates from `:_content-type:` to `:_mod-docs-content-type:`.
33
40
link:https://github.com/redhat-documentation/modular-docs/issues/203[#203]
34
41
35
-
42
+ [discrete]
36
43
== 2023: May
37
44
38
45
* Removed the *module prefixes* (`proc_`, `con_`, and `ref_`) from anchors (IDs) both in the reference guide and the module templates.
39
46
link:https://github.com/redhat-documentation/modular-docs/pull/201[#201]
40
47
41
-
48
+ [discrete]
42
49
== 2022: September
43
50
44
51
* Added a guidance for *assembly titles*.
45
52
link:https://github.com/redhat-documentation/modular-docs/pull/192[#192]
46
53
47
-
54
+ [discrete]
48
55
== 2022: August
49
56
50
57
* Added many clarifications to the guidance covering modules and assemblies. Added definitions for the *Limitations*, *Troubleshooting*, and *Next steps* sections in procedure modules.
@@ -53,7 +60,7 @@ link:https://github.com/redhat-documentation/modular-docs/pull/208[#208]
53
60
* Updated the name of the *content type attribute* in the templates from `:_module-type:` to `:_content-type:`.
54
61
link:https://github.com/redhat-documentation/modular-docs/pull/191[#191]
55
62
56
-
63
+ [discrete]
57
64
== 2022: April
58
65
59
66
* Updated headings in the reference guide and in the templates from title case to *sentence case*.
@@ -62,25 +69,25 @@ link:https://github.com/redhat-documentation/modular-docs/pull/189[#189]
62
69
* Removed the `*[role="_abstract"]*` tag from the templates.
63
70
link:https://github.com/redhat-documentation/modular-docs/issues/184[#184]
64
71
65
-
72
+ [discrete]
66
73
== 2022: March
67
74
68
75
* Added an *assembly attribute* to identify assemblies and improved the guidance for *snippets*.
69
76
link:https://github.com/redhat-documentation/modular-docs/pull/176[#176] and link:https://github.com/redhat-documentation/modular-docs/pull/178[#178]
70
77
71
-
78
+ [discrete]
72
79
== 2021: August
73
80
74
81
* Changed the guidelines for *concept modules* to allow examples and simple *actions* in certain cases.
75
82
link:https://github.com/redhat-documentation/modular-docs/pull/150[#150]
76
83
77
-
84
+ [discrete]
78
85
== 2021: June
79
86
80
87
* Added a guidance for *text snippets* and a convention that *modules should not contain other modules*.
81
88
link:https://github.com/redhat-documentation/modular-docs/pull/161[#161]
82
89
83
-
90
+ [discrete]
84
91
== 2021: April
85
92
86
93
* Added a convention saying that the *Prerequisites* heading is always plural.
@@ -89,6 +96,7 @@ link:https://github.com/redhat-documentation/modular-docs/pull/157[#157]
89
96
* Clarified the use of cross-references (xrefs) in modules.
90
97
link:https://github.com/redhat-documentation/modular-docs/pull/162[#162]
91
98
99
+ [discrete]
92
100
== 2021: January
93
101
94
102
* Changed *Verification steps* to *Verification* and clarified the use of numbered lists in modules.
0 commit comments