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

Run Vale over the style guide Part 1 #450

Closed
daobrien opened this issue Dec 14, 2022 · 1 comment
Closed

Run Vale over the style guide Part 1 #450

daobrien opened this issue Dec 14, 2022 · 1 comment
Assignees
@daobrien
Labels
P3 Can wait, but not too long. WIP Working on it. Branch probably exists.
Milestone
6.1

Comments

@daobrien
Copy link
Collaborator

The style guide needs to follow its own rules except when documenting examples
of exceptions or of what not to do.

This is a big job and needs to be done in sections, probably one file at a time,
and probably focusing first on errors and not warnings.
@daobrien daobrien added the P3 Can wait, but not too long. label Dec 14, 2022
@daobrien daobrien self-assigned this Dec 14, 2022
@daobrien daobrien added this to the 6.1 milestone Dec 14, 2022
@daobrien
Copy link
Collaborator Author

daobrien commented Dec 19, 2022 •
edited
Loading

  • 0-9.xml
  • Audience.xml
  • Author_Group.xml
  • A.xml
  • Book_Design.xml
  • Book_Info.xml
  • B.xml
  • Cross_references.xml
  • C.xml
  • Design.xml

@daobrien daobrien added the WIP Working on it. Branch probably exists. label Dec 19, 2022
daobrien pushed a commit that referenced this issue Dec 19, 2022
Working on #450.
ce9dd60
@daobrien daobrien changed the title Run Vale over the style guide Run Vale over the style guide Part 1 Jan 23, 2023
@daobrien daobrien mentioned this issue Jan 23, 2023
Merged
@daobrien daobrien closed this as completed Feb 9, 2023
julian-cable added a commit that referenced this issue Aug 23, 2023
@julian-cable @daobrien
@mweetman-redhat @CBID2 @rclee33 @harpasin
Merge all updates from dev to master for 6.1 release (#523)
4c54b6d 
* 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)

---------

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>
julian-cable added a commit that referenced this issue 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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@daobrien daobrien

Labels
P3 Can wait, but not too long. WIP Working on it. Branch probably exists.
Projects
None yet
Milestone
6.1
Development

No branches or pull requests
1 participant
@daobrien