Issue119 Concept-module rules are too strict

[emmurphy1]

See Issue 119 for the discussion.

[yzimmerm]

= Latency improvement by minimizing memory swapping

[role="_abstract"]
Swapping pages to disk can introduce latency in any environment. To ensure low latency, ensure that you have enough memory in your systems, so that swapping is not necessary. Always size the physical RAM as appropriate for your application and system.

Use the [command]vmstat command to monitor memory usage and watch the [parameter]si (swap in) and [parameter]so (swap out) fields. It is optimal that they remain zero as much as possible.

[literal,subs="+quotes,verbatim"]

$ vmstat
procs -----------memory---------- ---swap--- -----io---- --system-- ------cpu-----
r b swpd free buff cache si so bi bo in cs us sy id wa st
9 0 4186588 517872 28 4366932 0 1 4 207 0 1 9 3 88 0 0

[sterobin]

Wording addition per meeting. Just a start. Feel free to tweak as needed.

... procedure modules. However, in some cases a concept or reference can include suggested actions when those actions are simple, are highly dependent on the context of the module, and have no place in any procedure module. In such cases, ensure that the heading of the concept or reference remains a noun phrase and not a gerund.

For example, see the following section for link:https://access.redhat.com/documentation/en-us/red_hat_process_automation_manager/7.9/html-single/developing_decision_services_in_red_hat_process_automation_manager/index#bound_variables_in_patterns_and_constraints[Bound variables in patterns and constraints] and other sections that follow it in the example document. These concept and reference modules contain actions that are not suitable for standalone procedure modules but are relevant actions to understand in the context of the concept or reference being described.

[sterobin]

Not sure how much of the above actual doc instruction to duplicate here in the template. Maybe the same instruction from above but exclude the example? Trying to be consistent and clear while not burdening the template too much.

[ncbaratta]

lgtm

[rkratky]

Suggested change

"Bound variables in patterns and constraints"] and the sections that follow it. These concept and reference modules contain actions that are not suitable for standalone procedure modules but are relevant actions to understand in the context of the concept or reference being described.

[emmurphy1]

@rkratky can you explain why you don't want to include the examples?This is for the guide and not the template. I think the examples are very useful. The concept is somewhat abstract and I am afraid that writers will misinterpret this exception and use if for more explicit action.