search

redhat-documentation / modular-docs

Modular Documentation Project provides guidelines and examples for writing technical documentation using a modular framework.
Creative Commons Attribution Share Alike 4.0 International
80 stars 67 forks source link

Clarify that the "Prerequisites" heading is always plural #153

Closed bergerhoffer closed 3 years ago

bergerhoffer commented 3 years ago

Unless I'm mistaken, the "Prerequisites" heading should always be plural, even if there is only one prereq listed. If this is correct, can we clarify that, either in the guide or the templates?

I've recently seen a few instances in our repo where people were using "Prerequisite" singular when there was only one listed.

emmurphy1 commented 3 years ago

Yes, that is correct Andrea. Always plural and a bulleted list even if that list only has one item. Perhaps we need to add a comment about that in the templates.

IngridT1 commented 3 years ago

Perhaps the templates and the style guide?

bergerhoffer commented 3 years ago

Perhaps the templates and the style guide?

I don't think it necessarily needs to be in the style guide, as long as it's spelled out in the mod docs guide or templates (procedure and assembly).

mikemckiernan commented 3 years ago

A small update make sense to me.

bergerhoffer commented 3 years ago

Closing this issue since @mikemckiernan submitted an update. Thanks all!