From 3b1839202090d845a29649d927bc9baa8a91469b Mon Sep 17 00:00:00 2001 From: Mirek Jahoda Date: Fri, 15 Dec 2023 16:53:49 +0100 Subject: [PATCH 1/3] Add 2023 PRs --- .../content/topics/whats-new.adoc | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/modular-docs-manual/content/topics/whats-new.adoc b/modular-docs-manual/content/topics/whats-new.adoc index 268ca9a..05434ae 100644 --- a/modular-docs-manual/content/topics/whats-new.adoc +++ b/modular-docs-manual/content/topics/whats-new.adoc @@ -11,7 +11,24 @@ For a complete list of changes, see link:https://github.com/redhat-documentation // * // link: +== 2023: December + +* Added the *What's new* section to the link:https://redhat-documentation.github.io/modular-docs/[Modular documentation reference guide]. +link:https://github.com/redhat-documentation/modular-docs/pull/214[#214] +* Added references to the *link:https://redhat-documentation.github.io/supplementary-style-guide/#shortdesc[Short descriptions]* section in the Red Hat SSG where describing the introduction of an assembly or a module. +link:https://github.com/redhat-documentation/modular-docs/pull/216/files[#216] + +== 2023: September + +* 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. +link:https://github.com/redhat-documentation/modular-docs/pull/210/files[#210] + == 2023: August -* Updated the name of the content type attribute in the templates from `:_content-type:` to `:_mod-docs-content-type:`. +* Updated the name of the *content type attribute* in the templates from `:_content-type:` to `:_mod-docs-content-type:`. link:https://github.com/redhat-documentation/modular-docs/issues/203[#203] + +== 2023: May + +* Removed the *module prefixes* (`proc_`, `con_`, and `ref_`) from anchors (IDs) both in the reference guide and the module templates. +link:https://github.com/redhat-documentation/modular-docs/pull/201[#201] \ No newline at end of file From 45ffe4e2e7dc517580810117c061456b6dca119d Mon Sep 17 00:00:00 2001 From: Mirek Jahoda Date: Fri, 15 Dec 2023 17:19:38 +0100 Subject: [PATCH 2/3] Add 2022 PRs --- .../content/topics/whats-new.adoc | 33 ++++++++++++++++--- 1 file changed, 28 insertions(+), 5 deletions(-) diff --git a/modular-docs-manual/content/topics/whats-new.adoc b/modular-docs-manual/content/topics/whats-new.adoc index 05434ae..ef90602 100644 --- a/modular-docs-manual/content/topics/whats-new.adoc +++ b/modular-docs-manual/content/topics/whats-new.adoc @@ -13,15 +13,15 @@ For a complete list of changes, see link:https://github.com/redhat-documentation == 2023: December -* Added the *What's new* section to the link:https://redhat-documentation.github.io/modular-docs/[Modular documentation reference guide]. +* Added the *What's new* section to the Modular documentation reference guide. link:https://github.com/redhat-documentation/modular-docs/pull/214[#214] -* Added references to the *link:https://redhat-documentation.github.io/supplementary-style-guide/#shortdesc[Short descriptions]* section in the Red Hat SSG where describing the introduction of an assembly or a module. -link:https://github.com/redhat-documentation/modular-docs/pull/216/files[#216] +* 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. +link:https://github.com/redhat-documentation/modular-docs/pull/216/[#216] == 2023: September * 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. -link:https://github.com/redhat-documentation/modular-docs/pull/210/files[#210] +link:https://github.com/redhat-documentation/modular-docs/pull/210[#210] == 2023: August @@ -31,4 +31,27 @@ link:https://github.com/redhat-documentation/modular-docs/issues/203[#203] == 2023: May * Removed the *module prefixes* (`proc_`, `con_`, and `ref_`) from anchors (IDs) both in the reference guide and the module templates. -link:https://github.com/redhat-documentation/modular-docs/pull/201[#201] \ No newline at end of file +link:https://github.com/redhat-documentation/modular-docs/pull/201[#201] + +== 2022: September + +* Added a guidance for *assembly titles*. +link:https://github.com/redhat-documentation/modular-docs/pull/192[#192] + +== 2022: August + +* Updated the name of the *content type attribute* in the templates from `:_module-type:` to `:_content-type:`. +link:https://github.com/redhat-documentation/modular-docs/pull/191[#191] + +== 2022: April + +* Updated headings in the reference guide and in the templates from title case to *sentence case*. +link:https://github.com/redhat-documentation/modular-docs/pull/189[#189] +* Removed the `*[role="_abstract"]*` tag from the templates. +link:https://github.com/redhat-documentation/modular-docs/issues/184[#184] + +== 2022: March + +* Added an *assembly attribute* to identify assemblies and improved the guidance for *snippets*. +link:https://github.com/redhat-documentation/modular-docs/pull/176[#176] and link:https://github.com/redhat-documentation/modular-docs/pull/178[#178] + From df70438eeee966ff30ad6e22cc5ab6dd9c8ba23b Mon Sep 17 00:00:00 2001 From: Mirek Jahoda Date: Fri, 15 Dec 2023 19:25:45 +0100 Subject: [PATCH 3/3] Add 2021 PRs --- .../content/topics/whats-new.adoc | 38 +++++++++++++++++++ 1 file changed, 38 insertions(+) diff --git a/modular-docs-manual/content/topics/whats-new.adoc b/modular-docs-manual/content/topics/whats-new.adoc index ef90602..35e9939 100644 --- a/modular-docs-manual/content/topics/whats-new.adoc +++ b/modular-docs-manual/content/topics/whats-new.adoc @@ -11,47 +11,85 @@ For a complete list of changes, see link:https://github.com/redhat-documentation // * // link: + == 2023: December * Added the *What's new* section to the Modular documentation reference guide. link:https://github.com/redhat-documentation/modular-docs/pull/214[#214] + * 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. link:https://github.com/redhat-documentation/modular-docs/pull/216/[#216] + == 2023: September * 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. link:https://github.com/redhat-documentation/modular-docs/pull/210[#210] + == 2023: August * Updated the name of the *content type attribute* in the templates from `:_content-type:` to `:_mod-docs-content-type:`. link:https://github.com/redhat-documentation/modular-docs/issues/203[#203] + == 2023: May * Removed the *module prefixes* (`proc_`, `con_`, and `ref_`) from anchors (IDs) both in the reference guide and the module templates. link:https://github.com/redhat-documentation/modular-docs/pull/201[#201] + == 2022: September * Added a guidance for *assembly titles*. link:https://github.com/redhat-documentation/modular-docs/pull/192[#192] + == 2022: August +* Added many clarifications to the guidance covering modules and assemblies. Added definitions for the *Limitations*, *Troubleshooting*, and *Next steps* sections in procedure modules. +link:https://github.com/redhat-documentation/modular-docs/pull/208[#208] + * Updated the name of the *content type attribute* in the templates from `:_module-type:` to `:_content-type:`. link:https://github.com/redhat-documentation/modular-docs/pull/191[#191] + == 2022: April * Updated headings in the reference guide and in the templates from title case to *sentence case*. link:https://github.com/redhat-documentation/modular-docs/pull/189[#189] + * Removed the `*[role="_abstract"]*` tag from the templates. link:https://github.com/redhat-documentation/modular-docs/issues/184[#184] + == 2022: March * Added an *assembly attribute* to identify assemblies and improved the guidance for *snippets*. link:https://github.com/redhat-documentation/modular-docs/pull/176[#176] and link:https://github.com/redhat-documentation/modular-docs/pull/178[#178] + +== 2021: August + +* Changed the guidelines for *concept modules* to allow examples and simple *actions* in certain cases. +link:https://github.com/redhat-documentation/modular-docs/pull/150[#150] + + +== 2021: June + +* Added a guidance for *text snippets* and a convention that *modules should not contain other modules*. +link:https://github.com/redhat-documentation/modular-docs/pull/161[#161] + + +== 2021: April + +* Added a convention saying that the *Prerequisites* heading is always plural. +link:https://github.com/redhat-documentation/modular-docs/pull/157[#157] + +* Clarified the use of cross-references (xrefs) in modules. +link:https://github.com/redhat-documentation/modular-docs/pull/162[#162] + +== 2021: January + +* Changed *Verification steps* to *Verification* and clarified the use of numbered lists in modules. +link:https://github.com/redhat-documentation/modular-docs/pull/148[#148] \ No newline at end of file