Skip to content

Conversation

koozz
Copy link
Member

@koozz koozz commented Jul 11, 2025

This pull request primarily focuses on improving the readability and consistency of the OSPO book content by addressing grammar, formatting, and terminology issues. Additionally, it includes a minor configuration change in the .vale linting rule. Below is a summary of the most important changes grouped by theme.

Grammar and Style Improvements:

  • Updated phrasing for clarity and grammatical correctness, such as replacing "early-stage" with "early stage" and "publicly-visible" with "publicly visible" across multiple sections (ospo-book/content/en/02-chapter.md, ospo-book/content/en/03-chapter.md, ospo-book/content/en/04-chapter.md, ospo-book/content/en/toc.md). [1] [2] [3] [4]
  • Improved sentence structure and punctuation, such as fixing "get it" to "get it." for proper punctuation in ospo-book/content/en/02-chapter.md.

Code and Formatting Adjustments:

  • Enclosed code identifiers like xz/liblzma in backticks for consistency with markdown formatting in ospo-book/content/en/02-chapter.md. [1] [2]
  • Capitalized terms like "Multi-Factor Authentication" and "Continuous Integration" for consistency in ospo-book/content/en/05-chapter.md.

Linting Configuration Change:

  • Updated the .vale linting configuration to change the scope from raw to sentence, to improve the accuracy and exclude MarkDown tables of linting checks in .vale/TODO/EmDashes.yml.

Terminology Refinements:

  • Replaced "workers/contractors" with "workers and contractors" for better readability in ospo-book/content/en/03-chapter.md.
  • Clarified "external/upstream work" to "external and upstream work" for improved understanding in ospo-book/content/en/06-chapter.md.

Fixes: #556

@koozz koozz requested review from a team as code owners July 11, 2025 11:43
Copy link

netlify bot commented Jul 11, 2025

Deploy Preview for ospobook ready!

Name Link
🔨 Latest commit 020475c
🔍 Latest deploy log https://app.netlify.com/projects/ospobook/deploys/6877aa6a93166200087bf4ba
😎 Deploy Preview https://deploy-preview-654--ospobook.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

Copy link

netlify bot commented Jul 11, 2025

Deploy Preview for ospomindmap canceled.

Name Link
🔨 Latest commit 020475c
🔍 Latest deploy log https://app.netlify.com/projects/ospomindmap/deploys/6877aa6a2c1d270008e812d4

Copy link
Contributor

@alice-sowerby alice-sowerby left a comment

Choose a reason for hiding this comment

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

Thanks for the updates - the em-dash rule is still creating a few issues, as is the rule about hyphenating adverbs. I can update the writing style guide to tackle the latter.

@koozz
Copy link
Member Author

koozz commented Jul 15, 2025

Thanks for the updates - the em-dash rule is still creating a few issues, as is the rule about hyphenating adverbs. I can update the writing style guide to tackle the latter.

You are totally right, let me check my style locally and/or fix the issue.

Corrections for `supply-side` and `early-stage`.

Co-authored-by: Alice Sowerby <[email protected]>
Signed-off-by: Jan van den Berg <[email protected]>
@koozz
Copy link
Member Author

koozz commented Jul 16, 2025

Thanks again @alice-sowerby, it should be correct now.

Copy link
Contributor

@alice-sowerby alice-sowerby left a comment

Choose a reason for hiding this comment

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

Looks great! @koozz thank you.

@alice-sowerby alice-sowerby merged commit d518b76 into todogroup:main Jul 17, 2025
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[OSPO Book] Prepare a standard for written content
2 participants