search

patternfly / patternfly-quickstarts

Repository containing the PatternFly Quick Start extension code
MIT License
15 stars 38 forks source link

[Quickstart] Typo in auto-generated sentence #170

Closed AedinC closed 2 years ago

AedinC commented 2 years ago

There is a typo (addtion) in the auto generated sentence in line 233: https://github.com/patternfly/patternfly-quickstarts/blob/1972669cd78212106356b9c409fb21dbc809a6ad/packages/transform-adoc/src/react-converter/util.tsx#L233

Can this please be corrected to addition. Also, the sentence does not adhere to the guidelines in the Lead-in wording subsection of Lists in the IBM style guide (To avoid possible translation problems, use complete sentences to introduce lists and not phrases.) I recommend the following rewrite:

In addition to the prerequisites for this quick start, you have completed the following requirements for this step:

AedinC commented 2 years ago

Hi @jschuler. Just wondering when this issue is likely to be picked up? Many thanks!

AedinC commented 2 years ago

Hi @jschuler. Thanks for picking this up. I can see the typo will be fixed in #185. I have a shorter suggestion for the sentence rewrite, if this can be amended: In addition to the prerequisites for this Quick Start, this step requires the following actions:

jschuler commented 2 years ago

Thanks @AedinC , I'll involve our content team in the phrasing of that sentence. I'll create a separate issue for that