Skip to content

issue-240 Remove 'Limitations' from the reference guide #241

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.

Sign up for GitHub

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

Merged
emmurphy1 merged 1 commit into from
Apr 14, 2025
Merged

issue-240 Remove 'Limitations' from the reference guide #241

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 0 additions & 4 deletions modular-docs-manual/content/topics/creating_procedure_modules.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,10 +29,6 @@ The introduction typically provides context for the procedure, such as:

For details and examples, see the link:https://redhat-documentation.github.io/supplementary-style-guide/#shortdesc[Short descriptions] section in the Red Hat supplementary style guide.

[id="limitations"]
.Limitations
This section is optional and not used often. If there are any limitations that affect the procedure, list them in this section. Use a bulleted list for limitations and the plural heading *Limitations*, even if your procedure only has a single limitation.

[id="prerequisites"]
.Prerequisites
This section is optional. Prerequisites are a bulleted list of conditions that must be satisfied before the user starts the procedure. Use a bulleted list for prerequisites and the plural heading *Prerequisites*, even if your procedure only has a single prerequisite.
Expand Down
5 changes: 5 additions & 0 deletions modular-docs-manual/content/topics/whats-new.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,11 @@ For a complete list of changes, see link:https://github.com/redhat-documentation
// link:<URL of the GitHub issue associated with this change>

[discrete]
== 2025: April

* Removed 'Limitations' section from the Procedure section.
* Updated the comments in the templates to provide guidance to prepare for migration to DITA.

== 2024: January

* Removed the `*[role="_abstract"]*` tag from the templates (regression).
Expand Down