Skip to content

Commit a9e7013

Browse files
harpasindaobriendaobrienmweetman-redhatCBID2
authored
Updating master (#627)
* Working on #450. * Run Vale over Design.xml. This is the end of part 1/4 of "Run Vale over the style guide." Too big a job to try to handle in one issue and PR. * Ongoing updates for #456 * Closes #456 Part 2 of running Vale over the style guide. I also addressed a few other issues along the way, such as one sentence per line and removing old comments. Language.xml in particular contains lots of examples of what not to do, so it produces lots of noise in Vale. * s/may/might/ per Julian's review. * Working on #457 Run Vale of the style guide part 3. * Closes #457 Run Vale over the style guide, part 3. * Remove spurious space. * Closes #458 Run Vale over style guide part 4. * Closes #365 Remove DocBook references. * Closes #78 Update entry for "virtualized". Basically copy/paste from corp guide. * Closes #355. Improve a bit of formatting. * feat: Add advice on naming the default branch in an inclusive way. (#493) * feat: Add advice on naming the default branch in an inclusive way. * Update en-US/Language.xml Co-authored-by: julian-cable <79939933+julian-cable@users.noreply.github.com> * Update en-US/Language.xml Co-authored-by: julian-cable <79939933+julian-cable@users.noreply.github.com> * Update en-US/Language.xml Co-authored-by: julian-cable <79939933+julian-cable@users.noreply.github.com> --------- Co-authored-by: julian-cable <79939933+julian-cable@users.noreply.github.com> * Updated section about writing titles (#492) * Updated section about writing titles * Reverted title ID * Further edits * Updated guidance on continuation prompts (#494) * Various fixes for 6.1 release (#495) * Various fixes for 6.1 release * XML fix * Updated IBM Style access info (#496) * Updated term entries (#497) * Added guidance on omitting part of an output (#500) * Added guidance on omitting part of an output * Updated wording * Typo fix * Updated sample names and other small fixes (#502) * Various fixes (#512) * Implementing various feedback suggestions from Rachel (#513) * Implementing various feedback suggestions from Rachel * Addressed review comments * Addressed further review comment * Added more punctuation guidance (#515) * Added more punctuation guidance * Implemented review feedback * Updated audience description (#518) * Updated audience description * Further updated audience wording * Adding information about posessives (#519) * feat: added section about posessives * feat: here's the actual section * fix: made some revisions * Content and formatting updates * Update en-US/Punctuation.xml Co-authored-by: Rachel Lee <131199744+rclee33@users.noreply.github.com> * fix: made some revisions * fix: made another revision * Removed company name and restructured section * added link in section 3.6 * Final XML fix --------- Co-authored-by: Julian Cable <jcable@redhat.com> Co-authored-by: Rachel Lee <131199744+rclee33@users.noreply.github.com> * Updated view and edit files section * Added release notes for 6.1 and updated version information (#522) * updating homepage (#525) * 6.2 quick fixes (#544) * Some updates concerning punctuation (#545) * Updated guidance for punctuation and special characters * Enhanced guidance about punctuation in lists * Minor formatting * Content and formatting * Applied feedback * Minor fixes * Word usage updates: screenshot, lookup, see/refer to (#546) * Word usage updates: screenshot, lookup, see/refer to * Addresses one comment * Updates to see/refer to entries * Minor fix * Line continuation for multiple operating systems (#548) * Line continuation for multiple operating systems * Minor edit * Add 64-bit architecture guidance (#547) * Add 64-bit architecture guidance * Implementing edits from review * Updated Boolean guidance and a bug fix (#551) * Updated Boolean guidance and a bug fix * Update to Boolean entry * Reworked entries for tar, tarball, untar, unzip, zip (#552) * Clarify capitalization for table titles (#553) * Updates on referring to object names and using realistic usernames (#554) * Updates on referring to object names and using realistic usernames * Apply review comments * Updates for apostrophes and quotation marks (#557) * Updates for apostrophes and quotation marks * Updated list of punctuation marks * Updated guidance about titles (#559) * Updated guidance about titles * Change 'book' to 'publication' * Footnote update (#560) * adding ulink tag to a url * Replace an invalid URL --------- Co-authored-by: Julian Cable <jcable@redhat.com> * fix(docs): add some build instructions (#562) * fix(docs): add some build instructions * feat: add build shortcut * Added small comment --------- Co-authored-by: julian-cable <jcable@redhat.com> * Corrected some titles to use title case (#563) * Add release notes and update version info (#564) * Add release notes and update version info * Minor wording fix * Remove 'check' entry (#579) * Add 'sign-in' (#580) * Add 'sign-in' * Update login, sign-in, sign-on * XML validation fixes * Implement suggestions from Ashley D'Andrea (#589) * Implement suggestions from Ashley D'Andrea * Apply feedback from Rachel * Apply feedback from Ashley * Add guidance for 'named' and 'called' (#591) * Add guidance for 'named' and 'called' * Further edit * Update guidance for 'go to' (#592) * Update guidance for 'go to' * Add a clarification * Add gitignore for untracked files (#590) * Update guidance about 'Overview' as a title (#593) * Clarify guidance for 'lifecycle' (#594) * Remove yes/no as values for Ansible 'become' * Edits to address feedback in #600 * Update en-US/Design.xml * Update en-US/Design.xml * fixes two sentences on one line * Update 'dialog box' entry (#603) * Update 'dialog box' entry * Further updates * Various fixes (#604) * Various fixes * Address comments * Apply final feedback * Wording change * Add 'mission-critical' * Add EPUB * Implement comments * Implement comments * Final fix * Final fix * Update references to IBM Style with links, and remove marketing references (#609) * Mock-up of new link format to IBM Style with padlock icon * Remove marketing references and explain padlock icon in front matter * Update references to IBM Style with links * Implement suggestions part 1 * Implement suggestions part 2 * Update IaC (#612) * Updates for dashes, terminal, omitting output (#618) * Updates for dashes, terminal, omitting output * add shell prompt example * Further updates * Update abstract wording (#619) * Update abstract wording * Minor rewording * Add release notes (#620) * Add release notes * Apply feedback * Add 'hardened', update 'secure', update omitted output (#621) * Add 'hardened', update 'secure', update omitted output * Apply feedback * Updated audience section for Homepage (#623) * updating index page * Update index.html Co-authored-by: julian-cable <79939933+julian-cable@users.noreply.github.com> --------- Co-authored-by: julian-cable <79939933+julian-cable@users.noreply.github.com> * updating index page for v7.0 (#624) * updating index page for the latest version * Update index.html Co-authored-by: julian-cable <79939933+julian-cable@users.noreply.github.com> --------- Co-authored-by: julian-cable <79939933+julian-cable@users.noreply.github.com> * Add dark mode enhancement to What's New (#626) --------- Co-authored-by: daobrien <noreply@solaris.milky.way> Co-authored-by: David O'Brien <daobrien@users.noreply.github.com> Co-authored-by: mweetman-redhat <mweetman@redhat.com> Co-authored-by: Christine Belzie <105683440+CBID2@users.noreply.github.com> Co-authored-by: julian-cable <79939933+julian-cable@users.noreply.github.com> Co-authored-by: Julian Cable <jcable@redhat.com> Co-authored-by: Rachel Lee <131199744+rclee33@users.noreply.github.com> Co-authored-by: Alex Corcoles <alex@pdp7.net> Co-authored-by: Ashley D'Andrea <jdandrea@gmail.com> Co-authored-by: Steven Bonneville <sbonnevi@redhat.com> Co-authored-by: Rachel Lee <ralee@redhat.com>
1 parent a12ef03 commit a9e7013

File tree

2 files changed

+10
-6
lines changed

2 files changed

+10
-6
lines changed

en-US/New.xml

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,8 @@
77
<title>New in This Release</title>
88
<formalpara id="new_70">
99
<title>Release 7.0</title>
10-
<para>Major update in October 2024 with migration to a new hosting site, and extensive added and updated guidance.</para>
10+
<para>Major update in November 2024, with extensive added and updated guidance.</para>
11+
<!-- <para>Major update in November 2024 with migration to a new hosting site, and extensive added and updated guidance.</para> -->
1112
</formalpara>
1213
<itemizedlist>
1314
<!-- <listitem>
@@ -76,6 +77,9 @@
7677
<para>Added the pipe character to the table of special characters.
7778
Refer to <xref linkend="punc-names"/>.</para>
7879
</listitem>
80+
<listitem>
81+
<para>If dark mode is selected, it now persists across web page refreshes.</para>
82+
</listitem>
7983
<listitem>
8084
<para>Various other fixes.</para>
8185
</listitem>

index.html

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -41,8 +41,8 @@
4141

4242
<div>
4343
<h3>
44-
<a target="_self" href="https://stylepedia.net/style/6.2" style="text-decoration: underline;" title="The Red&nbsp;Hat Technical Writing Style Guide">
45-
<img class="social" src="font/fontawesome/svgs/brands/readme.svg" alt="Style Guide" width="40em" /> Red&nbsp;Hat Technical Writing Style Guide v6.2</a>
44+
<a target="_self" href="./style/" style="text-decoration: underline;" title="Red&nbsp;Hat Technical Writing Style Guide">
45+
<img class="social" src="font/fontawesome/svgs/brands/readme.svg" alt="Style Guide" width="40em" /> Red&nbsp;Hat Technical Writing Style Guide v7.0</a>
4646
</h3>
4747
<h3>
4848
<a href="https://www.redhat.com/en/about/brand/standards" target="_blank" style="text-decoration: underline;">
@@ -51,15 +51,15 @@ <h3>
5151
<p>
5252
<br>
5353
This guide is the official style guide for Red&nbsp;Hat training and certification content, and for all other technical documentation except as stated.
54-
Red&nbsp;Hat product documentation by Customer Content Services (CCS) follows the <a style="text-decoration: underline; font-size: 1em;" href="https://redhat-documentation.github.io/supplementary-style-guide/">Red&nbsp;Hat supplementary style guide</a> instead of this Red&nbsp;Hat Technical Writing Style Guide.
54+
Red&nbsp;Hat product documentation follows the <a style="text-decoration: underline; font-size: 1em;" href="https://redhat-documentation.github.io/supplementary-style-guide/">Red&nbsp;Hat Supplementary Style Guide</a> instead of this guide.
5555
</p>
5656
<br>
5757
<p>
58-
The Red&nbsp;Hat Technical Writing Style Guide includes everyday punctuation and grammar, common mistakes to avoid, strategies for translation and global audiences, and a word usage dictionary.
58+
The Red&nbsp;Hat Technical Writing Style Guide includes guidance for everyday punctuation and grammar, common mistakes and how to avoid them, strategies for translation and global audiences, content design guidance, and a word usage dictionary.
5959
</p>
6060
<br>
6161
<p>
62-
This guide is a public guide. It is reviewed and maintained by Red Hat. Contributions from the wider community are always welcomed.
62+
This guide is a public and open source guide. It is reviewed and maintained primarily by Red&nbsp;Hat. Contributions from the wider community are always welcome.
6363
</p>
6464
</div>
6565
</div>

0 commit comments

Comments
 (0)