search

StyleGuides / WritingStyleGuide

The official Red Hat guide to writing clear, concise, and consistent technical documentation.
Creative Commons Attribution Share Alike 4.0 International
71 stars 19 forks source link

Glance and Maven examples are written as titles instead of sentences #586

Open jdandrea opened 4 days ago

jdandrea commented 4 days ago

https://github.com/StyleGuides/WritingStyleGuide/blob/1604485f16a472b329a43551ba561ecd8b7416c4/en-US/Translation.xml#L628-L629

Suggestion: Replace the example with "Troubleshoot Glance.", and the improvement with "Troubleshoot the Glance image service."

https://github.com/StyleGuides/WritingStyleGuide/blob/1604485f16a472b329a43551ba561ecd8b7416c4/en-US/Translation.xml#L633-L634

Suggestion: Replace the example with "Install the maven-changelog-plugin.", and the improvement with "Install the maven-changelog-plugin package."