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 20 forks source link

Update references to stylepedia.net in the IBM style guide #514

Open rclee33 opened 1 year ago

rclee33 commented 1 year ago

There might be a plan for this already, but in case there’s not — the IBM Style Guide mentions and links to the Red Hat writing guide at stylepedia.net. After the Red Hat guide migrates to redhat.com, these mentions and links will need to be updated.

For example, from the “Red Hat versus IBM conventions for style” section: https://www.ibm.com/docs/en/ibm-style?topic=medium-red-hat

Mentions: Red Hat writing style > second bulleted list "Stylepedia supersedes IBM Style in the event of any contradictions:" "- Red Hat Technical Writing Style Guide at stylepedia.net" "- IBM Style for any topics not covered in the Stylepedia guide"

Embedded links: Related resources > Red Hat Technical Writing Style Guide [embedded link] at stylepedia.net

julian-cable commented 1 year ago

References to stylepedia.net from other places will also need to be changed at that time. Those places include: