Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fill the What's new section (retroactively, back to 2021) #218

Merged
merged 3 commits into from
Dec 20, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
80 changes: 79 additions & 1 deletion modular-docs-manual/content/topics/whats-new.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,85 @@ For a complete list of changes, see link:https://github.com/redhat-documentation
// * <Brief description of change. Include an inline link to the relevant section of the guide.>
// link:<URL of the GitHub issue associated with this change>


== 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&nbsp;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:`.
* 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]