Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add 64-bit architecture guidance #547

Merged
merged 3 commits into from
Nov 28, 2023
Merged

Add 64-bit architecture guidance #547

merged 3 commits into from
Nov 28, 2023

Conversation

julian-cable
Copy link
Collaborator

@julian-cable julian-cable commented Nov 23, 2023 •
edited
Loading

Implementing the formal documented guidance for these related terms, as approved by Word Nerds.

@julian-cable julian-cable linked an issue Nov 23, 2023 that may be closed by this pull request
Add agreed word usage guidance for 64-bit architecture #539
Closed
rclee33
rclee33 reviewed Nov 27, 2023
View reviewed changes
Copy link
Contributor

@rclee33 rclee33 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Completed my review!

en-US/0-9.xml Outdated
This term can refer to both AArch66/aarch64 and to ARM64/arm64.
</para>
<para>
Use this format in general cases when writing for both names of the architecture and various cloud providers.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not quite following the phrasing about "writing for both names of architectures and various cloud providers". I would expect writing "for" an audience, or "about" topics - but this phrasing seems to combine both, perhaps? For clarity, maybe: Use this format in general cases to refer to this architecture type for various cloud providers.

en-US/0-9.xml Outdated
Use this format in general cases when writing for both names of the architecture and various cloud providers.
</para>
<para>
Cloud providers can use different formats of this term when using architectures.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not quite understanding "when using architectures". (Aren't architectures always used?) For clarity, perhaps: Cloud providers might use different formats of this term when discussing architectures.

en-US/0-9.xml Outdated
</para>
<para>
Cloud providers can use different formats of this term when using architectures.
If you are documenting code, commands, or outputs, confer with your subject-matter expert on the correct format for the specific use case.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
If you are documenting code, commands, or outputs, confer with your subject-matter expert on the correct format for the specific use case.
If you are documenting code, commands, or outputs, then confer with your subject-matter expert on the correct format for the specific use case.

en-US/0-9.xml Outdated
<para>
<emphasis>n.</emphasis> A 64-bit version of the x86 architecture.
This term is a synonym of x86_64.
Use this format in general cases when writing for names of the architectures for various cloud providers.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider: Use this format in general cases to refer to this architecture type for various cloud providers.

en-US/0-9.xml Outdated
Use this format in general cases when writing for names of the architectures for various cloud providers.
</para>
<para>
Cloud providers can use different formats of this term when using architectures.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider: Cloud providers might use different formats of this term when discussing architectures.

en-US/I.xml Outdated
Correct.
<emphasis>n.</emphasis> The Intel 64-bit version of the x86 architecture.
Use this format when referring to information that is exclusive to Intel processors.
For Red&nbsp;Hat products, it applies only to Red&nbsp;Hat Enterprise Linux content.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Considering clarifying "it' -- the format, or Intel processors, or something else?

en-US/I.xml Outdated
For Red&nbsp;Hat products, it applies only to Red&nbsp;Hat Enterprise Linux content.
</para>
<para>
Cloud providers can use different formats of this term when using architectures.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider: Cloud providers might use different formats of this term when discussing architectures.

en-US/I.xml Outdated
</para>
<para>
Cloud providers can use different formats of this term when using architectures.
If you are documenting code, commands, or outputs, confer with your subject-matter expert on the correct format for the specific use case.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
If you are documenting code, commands, or outputs, confer with your subject-matter expert on the correct format for the specific use case.
If you are documenting code, commands, or outputs, then confer with your subject-matter expert on the correct format for the specific use case.

en-US/XYZ.xml Outdated
Use this format in backticks when referring to architecture as a value or parameter.
</para>
<para>
Cloud providers can use different formats of this term when using architectures.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider: Cloud providers might use different formats of this term when discussing architectures.

en-US/XYZ.xml Outdated
</para>
<para>
Cloud providers can use different formats of this term when using architectures.
If you are documenting code, commands or outputs, confer with your subject-matter expert on the correct format for the specific use case.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
If you are documenting code, commands or outputs, confer with your subject-matter expert on the correct format for the specific use case.
If you are documenting code, commands or outputs, then confer with your subject-matter expert on the correct format for the specific use case.

@julian-cable julian-cable merged commit 1fb8f6c into dev Nov 28, 2023
@julian-cable julian-cable deleted the jcable/6.2-64bit branch November 28, 2023 17:11
julian-cable added a commit that referenced this pull request Feb 27, 2024
@julian-cable @daobrien
@mweetman-redhat @CBID2 @rclee33 @harpasin @alexpdp7
Merge commits from dev to master branch for 6.2 release (#565)
ae704b2 
* 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

---------

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: Rachel Lee <131199744+rclee33@users.noreply.github.com>
Co-authored-by: Harpal Singh <52556240+harpasin@users.noreply.github.com>
Co-authored-by: Alex Corcoles <alex@pdp7.net>
julian-cable added a commit that referenced this pull request Oct 9, 2024
@julian-cable @daobrien
@mweetman-redhat @CBID2 @rclee33 @harpasin @alexpdp7 @jdandrea @bonnevil
Merge commits from dev to master branch for 7.0 release (#622)
a12ef03 
* 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

---------

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: Rachel Lee <131199744+rclee33@users.noreply.github.com>
Co-authored-by: Harpal Singh <52556240+harpasin@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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@rclee33 rclee33 rclee33 approved these changes

@daobrien daobrien Awaiting requested review from daobrien

@sffrench sffrench Awaiting requested review from sffrench

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Add agreed word usage guidance for 64-bit architecture
2 participants
@julian-cable @rclee33