Releases: StyleGuides/WritingStyleGuide
Version 7.0 of Red Hat Style Guide
Major update in October 2024 with migration to a new hosting site, and extensive added and updated guidance.
What's Changed
- Remove 'check' entry by @julian-cable in #579
- Add 'sign-in' by @julian-cable in #580
- Implement suggestions from Ashley D'Andrea by @julian-cable in #589
- Add guidance for 'named' and 'called' by @julian-cable in #591
- Update guidance for 'go to' by @julian-cable in #592
- Add gitignore for untracked files by @jdandrea in #590
- Update guidance about 'Overview' as a title by @julian-cable in #593
- Clarify guidance for 'lifecycle' by @julian-cable in #594
- Remove yes/no as values for Ansible 'become' by @bonnevil in #600
- Update 'dialog box' entry by @julian-cable in #603
- Various fixes by @julian-cable in #604
- Add 'mission-critical' by @julian-cable in #607
- Add EPUB by @julian-cable in #608
- Update references to IBM Style with links, and remove marketing references by @julian-cable in #609
- Update IaC by @julian-cable in #612
- Updates for dashes, terminal, omitting output by @julian-cable in #618
- Update abstract wording by @julian-cable in #619
- Add release notes by @julian-cable in #620
- Add 'hardened', update 'secure', update omitted output by @julian-cable in #621
New Contributors
Full Changelog: v6.2...v7.0
Contributors
Assets 2
Version 6.2 of Red Hat Style Guide
What's Changed
- 6.2 quick fixes by @julian-cable in #544
- Some updates concerning punctuation by @julian-cable in #545
- Word usage updates: screenshot, lookup, see/refer to by @julian-cable in #546
- Line continuation for multiple operating systems by @julian-cable in #548
- Add 64-bit architecture guidance by @julian-cable in #547
- Updated Boolean guidance and a bug fix by @julian-cable in #551
- Reworked entries for tar, tarball, untar, unzip, zip by @julian-cable in #552
- Clarify capitalization for table titles by @julian-cable in #553
- Updates on referring to object names and using realistic usernames by @julian-cable in #554
- Updates for apostrophes and quotation marks by @julian-cable in #557
- Updated guidance about titles by @julian-cable in #559
- Footnote update by @harpasin in #560
- fix(docs): add some build instructions by @alexpdp7 in #562
- Corrected some titles to use title case by @julian-cable in #563
- Add release notes and update version info by @julian-cable in #564
Full Changelog: v6.1...v6.2
Contributors
Assets 3
Version 6.1 of Red Hat Style Guide
What's Changed
- Vale check of Style Guide Part 1 by @daobrien in #459
- daobrien/456 vale check by @daobrien in #462
- daobrien/457 vale check by @daobrien in #464
- Closes #458 Run Vale over style guide part 4. by @daobrien in #467
- Closes #355. Add 'application velocity' from Corp Guide by @daobrien in #470
- Closes #365 Remove DocBook references. by @daobrien in #468
- Closes #78 Update entry for "virtualized". by @daobrien in #469
- feat: Add advice on naming the default branch in an inclusive way. by @CBID2 in #493
- Updated section about writing titles by @julian-cable in #492
- Updated guidance on continuation prompts by @julian-cable in #494
- Various fixes for 6.1 release by @julian-cable in #495
- Updated IBM Style access info by @julian-cable in #496
- Updated term entries by @julian-cable in #497
- Added guidance on omitting part of an output by @julian-cable in #500
- Updated sample names and other small fixes by @julian-cable in #502
- Various fixes by @julian-cable in #512
- Implementing various feedback suggestions from Rachel by @julian-cable in #513
- Added more punctuation guidance by @julian-cable in #515
- Updated audience description by @julian-cable in #518
- Adding information about posessives by @CBID2 in #519
- Updated view and edit files section by @julian-cable in #520
- Added release notes for 6.1 and updated version information by @julian-cable in #522
- updating homepage by @harpasin in #525
New Contributors
Full Changelog: v6.0...v6.1
Contributors
Assets 2
Version 6.0 of Red Hat Style Guide
What's Changed
- Fixes #409 and other required repairs. by @daobrien in #417
- daobrien/416 chris wright update by @daobrien in #418
- Applied various fixes for 6.0 by @julian-cable in #407
- Applied third batch of enhancements for 6.0 by @julian-cable in #420
- Applied second batch of enhancements for 6.0 by @julian-cable in #419
- Applied first batch of enhancements for 6.0 by @julian-cable in #414
- Added audience, new in this release, fix for 'like' entry by @julian-cable in #422
- Addresses #424 Add info on using captions. by @daobrien in #425
- Added captions and callouts item to what's new by @julian-cable in #428
- Fixes #356. Removes big RH logo from centre of page. by @daobrien in #434
- Added updated wording about verbs in titles by @julian-cable in #444
- Added example for 'unset' by @julian-cable in #442
- update preface.xml to add in audience file and resolve issue #408 by @nmuller66 in #445
- Final update to release notes for 6.0 by @julian-cable in #446
- Apply fixes from Nicole and update release month by @julian-cable in #449
- Merge all updates from dev to master for 6.0 release by @julian-cable in #447
Full Changelog: v5.1...v6.0
Contributors
Assets 2
Version 5.1 of Red Hat Style Guide
What's Changed
- s/http/https/ by @daobrien in #282
- Fixes #280 by @daobrien in #283
- Removes broken link to uinames by @daobrien in #284
- Add Google analytics info to index.html by @daobrien in #296
- Add entry for on(-, )premise(,s) by @alexpdp7 in #300
- Fix small issues by @alexpdp7 in #302
- Fixes #294 by @daobrien in #305
- #285 Minor punctuation fix by @julian-cable in #314
- Bogus change to test commits. by @julian-cable in #320
- #291 Diagram labels as sentence case only. by @julian-cable in #321
- #288 Added guidance about referring to object names. by @julian-cable in #329
- #318 Commented out section about gerunds and imperatives in titles. by @julian-cable in #328
- 293 Resolved a bug with referring to punctuation marks. by @julian-cable in #327
- #306 Added guidance about pronouncing file or directory names that begin with special characters. by @julian-cable in #326
- #310 Anthropomorphism: Avoid 'allow'. by @julian-cable in #324
- #312 Add subsection about consecutive headings. by @julian-cable in #323
- #308 Add 'prebaked' to slang examples. by @julian-cable in #322
- #313 Updated guidance for non-breaking spaces, in a new section. by @julian-cable in #325
- #299 Add IaC entry by @julian-cable in #331
- #303 Added allowed use of 'unset' by @julian-cable in #334
- Jcable/297 Change of standard for punctuation with quotation marks. by @julian-cable in #315
- #309 GUI elements wording change by @julian-cable in #332
- #286 Updated guidance for long commands by @julian-cable in #333
- #304 Added entry for 'number sign' by @julian-cable in #335
- Jcable/330 punc quot by @julian-cable in #336
- 337 Add guidance about referring to UI elements and other publication titles by @julian-cable in #338
- 339 Added information for IBM Style online by @julian-cable in #340
- 298 Update 'backend' by @julian-cable in #341
- 287 Add release notes by @julian-cable in #343
- 344 Update chapter 4 ID by @julian-cable in #345
- 348 Fix to triplicate headings by @julian-cable in #349
- Merge dev to master for 5.1 release by @daobrien in #350
New Contributors
Full Changelog: v5.0...v5.1
Contributors
Assets 2
Version 5.0 of Red Hat Style Guide
Changed guide title to “Red Hat Technical Writing Style Guide”. Changed subtitle to “Style Conventions for Writers and Editors”.
Added inclusive language guidance.
Added section on use of relative pronoun “that”.
Added sections on exclamation points and referring to punctuation marks.
Clarified that sentence case is required for captions, legends, and diagram labels.
Added section on phrasal verbs (two-word verb forms).
Added more categories of ambiguities to avoid.
Dates and Times: Changed times of day standard from “a.m.”, “p.m.” to “AM”, “PM”.
Usage A-Z added entries: appendixes, as long as, blacklist, colocate/colocation, display, following, i.e., indexes, login/log in/log in to, master, sign in/sign in to, slave, whitelist, wish
Updated entries: backwards-compatible, high-availability, hostname, lifecycle, OK, please, setup, username, ZIP Code
Removed guidance about DocBook and markup, to focus instead on writing.
Minor edits so the guide itself conforms more fully with its own advice.
Release 4.2 of Red Hat Style Guide
Updates to section on using line continuation characters and PS2 prompts, including indentation.
New and updated entries to Usage Dictionary.
Update section on option and argument terminology.
Release 4.1 of Red Hat Style Guide
Addresses a range of issues covered in #204
Release 4.0 of Red Hat Style Guide
The Red Hat Style Guide and Word Usage Dictionary is a joint effort by various groups within Red Hat. This major release addresses a number of issues ranging from typos to addressing changes in best practices and word usage to revised practices for documenting commands and syntax.
We've also included access to the Red Hat Training DocBook XML Guide which, while specific to the requirements of the Red Hat Training team, may prove useful to others who need a simple but robust model for their DocBook authoring requirements.
Release 1.0
Remove "snippet" from list of words to avoid. This term is in very common use and The IBM Style Guide (the fall-back) has no issue with it.