Review the history of significant updates to the Red Hat supplementary style guide for product documentation. You can see the full change history by reviewing the commits.
NOTE: History for 2023 and beyond is now documented in the guide: What's new section of the Red Hat supplementary style guide for product documentation.
- January 2023
- December 2022
- November 2022
- October 2022
- September 2022
- August 2022
- July 2022
- June 2022
- May 2022
- April 2022
- March 2022
- February 2022
- January 2022
- December 2021
- November 2021
- October 2021
- September 2021
- August 2021
- July 2021
- June 2021
- May 2021
- April 2021
- March 2021
- February 2021
- January 2021
- December 2020
- Removed "through" entry in favor of following the IBM Style guidance on number ranges
- Added glossary entry for bytecode
- Added guidance for documenting Developer Preview features
- Added glossary entry for Developer Preview
- Added glossary entry for Kubernetes
- Added glossary entry for Assisted Installer
- Added glossary entry for Basic HTTP authentication
- Added guidance for using non-breaking spaces between "Red" and "Hat"
- Added glossary entry for disconnected
- Removed "numbers" entry in favor of following the IBM Style guidance on numbers.
- Added link to the Red Hat Technical Writing Style Guide for training and exam content style guidance.
- Added glossary entry for regex and regular expression
- Added glossary entry for plugin
- Updated BIOS entry
- Updated GRUB entry
- Added guidance for cross-references, external links, and link text
- Added guidance for homographs
- Added glossary entry for Technology Preview
- Added guidance for documenting Technology Preview features
- Added glossary entries for networking terms: ACK, ACK flag, ARP, CIDR, DHCP, firewalld, IP address, IPv4, IPv6, MAC address, NAT, network bond, network team, O-RAN, Open RAN, OpenRAN, packet, TCP, and UDP
- Added glossary entries for additional OpenShift terms: compute node, control plane, horizontal pod autoscaler, Ingress, Ingress Controller, Operator Framework, Operator Lifecycle Manager, and OperatorHub
- Reorganized style guidelines into new categories
- Added .NET entry and updated .NET Core entry
- Added guidance for IP addresses and MAC addresses
- Updated Samba entry
- Added guidance for avoiding cost references
- Added glossary entry for Red Hat OpenShift Data Foundation and updated references of "Red Hat OpenShift Container Storage" to "Red Hat OpenShift Data Foundation"
- Added glossary entry for customer
- Reorganized glossary to remove the product-specific sections; glossary terms are now in a single alphabetical list
- Added glossary entries for permission and privilege
- Added glossary entries for TLS and TLS handshake
- Updated guidance for SSL/TLS
- Added product-specific (OpenShift) glossary entry for Red Hat OpenShift Cluster Manager
- Updated product-specific terminology for Red Hat OpenStack Platform
- Updated product-specific terminology for Red Hat Enterprise Linux
- Updated deprecation and removal notices in release notes doc texts
- Updated product-specific terminology for Red Hat Virtualization
- Added product-specific terminology for Red Hat Single Sign-On
- Added alternatives for the terms master and slave in the conscious language section
- Added a new section for guidelines specific to cloud services documentation
- Added product-specific terminology for Red Hat Directory Server
- Council decided to follow IBM Style guide guidance on Java terms "throw" and "catch"
- Added product-specific terminology for Red Hat Data Grid
- Added guidance for commands with root privileges
- Added an exception to avoiding statements about future plans for deprecation notices
- Added guidance for avoiding statements about future plans
- Added links to the related Red Hat guides
- Added the standard boilerplate note for Technology Preview features
- Added guidance for when to use the various admonition types
- Added "on-premises" and "on-prem" as incorrect forms of on-premise
- Added a link to Patternfly for guidance on documenting UI elements
- Added glossary entry for network interface controller (preferred over network interface card)
- Updated and moved glossary entry for Operator to the General conventions section
- Added glossary entry for Organization Administrator
- Added product-specific (OpenShift) glossary entry for quick start
- Added guidance for conscious language
- Added product-specific terminology for Red Hat OpenShift Container Storage
- Added guidance for writing prerequisites
- Added glossary entry for as expected
- Updated product-specific terminology for Red Hat JBoss Enterprise Application Platform
- Council decided to follow IBM Style guide "hostname" one word guidance
- Added icons for yes/no/with caution guidance for glossary entries
- Added guidance for avoiding contractions
- Added guidance for user-replaced values in XML
- Added product-specific terminology for RHEL
- Added glossary entry for standalone
- Council decided to follow IBM Style guide lowercase "internet" guidance
- Added guidance for release notes doc texts
- Added guidance to follow less conversational style as default tone
- Added guidance for single-step procedures
- Added guidance for using attributes for product names and versions
- Council decided to follow IBM Style guide "lifecycle" one word guidance
- Removed glossary entries that were duplicated by the new IBM Style guide
- Clarified AMD64 glossary entry
- Added glossary entry for Red Hat Ecosystem Catalog
- Updated glossary entry for Red Hat Container Catalog
- Added glossary entry for Git
- No major updates
- No major updates
- Updated Red Hat OpenShift glossary entries for new guidance API object terminology formatting.