Skip to content

DOCS-2743 / 27 / MinIO/AIStor trademark legal compliance (master) - #4775

Merged
micjohnson777 merged 9 commits into
masterfrom
DOCS-2743-min-io-legal-compliance-master
Sep 3, 2026
Merged

DOCS-2743 / 27 / MinIO/AIStor trademark legal compliance (master)#4775
micjohnson777 merged 9 commits into
masterfrom
DOCS-2743-min-io-legal-compliance-master

Conversation

@DjP-iX

@DjP-iX DjP-iX commented Sep 3, 2026

Copy link
Copy Markdown
Contributor

Summary

Same legal requirement as the apps-web repo work (DOCS-2743, already merged/open there in 2 PRs) — this is branch 1 of 9 for the /documentation repo. master establishes the pattern the other 8 release branches will reuse.

  • Marks the first mention of MinIO/AIStor on each affected page with correct capitalization, bold, and the ™ symbol, and adds the required attribution sentence to the page's footer.
  • Adds a trademark-notice shortcode + backing partial (layouts/partials/trademark-notice.html, layouts/shortcodes/trademark-notice.html) as the single source of truth for the exact attribution wording — the shortcode fails the build loudly (via errorf) if called without valid minio/aistor params, so a legal notice can't silently go missing on a typo.
  • Adds MinIO and AIStor entries to the site's existing central Copyrights.md trademarks page.
  • Fixes several casing bugs ("Minio", "minIO") found along the way, including in a shared include used by 3 pages on this branch, and 4 spots of docs-authored prose (not quoted ticket titles) in the historical content/_archive/COREReleaseNotes/ changelogs.
  • Covers 3 independent rendering paths beyond plain content pages that all surface a marked mention without carrying its own attribution: a shared install-wizard include, two section-index pages that list child-page summaries ({{< children >}}), and Hugo's built-in taxonomy/tag pages (layouts/_default/taxonomy.html, a repo-local template — this fix is reusable on all 8 remaining branches without modification, unlike the vendored-theme children shortcode).

Test plan

  • hugo --gc --minify builds clean (0 errors)
  • Every affected page/entry carries the exact attribution sentence once
  • First-mention-only marking verified (no double-marking)
  • No trademark markup leaks onto unrelated pages
  • Site-wide sweep: every "…is a trademark of the MinIO Corporation." emission across the whole built site is byte-exact, no variants
  • The trademark-notice shortcode's fail-loud error path independently re-tested live (bad/missing params correctly fail the build)
  • Each task individually reviewed; branch reviewed end-to-end three times as new gaps were found and fixed (a {{< children >}}-surfaced mention, then a taxonomy-page-surfaced mention)

Known pre-existing issue (not introduced by this PR, not fixed here)

Final review surfaced an unrelated bug: content/SCALE/GettingStarted/Migrate/_index.md declares aliases that collide with two real pages' own URLs, causing Hugo to non-deterministically pick either the real page or a redirect stub at the same output path across builds. Predates this branch; recommend a separate ticket.

🤖 Generated with Claude Code

DjP-iX and others added 8 commits September 3, 2026 12:39
…page

Per code review: the plan's casing-fix constraint is unconditional across
the whole page, not limited to the brief's enumerated edits. This
occurrence (third paragraph) was found during self-review but left
unfixed; review flagged it as required. Casing-only fix, no bold/TM
since this is not the page's first mention.
Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
…ypos

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Hugo's taxonomy pages (tags, plus this site's book/volume taxonomies)
render each listed page's auto-summary, which can include a page's
marked first mention without its footer attribution (the summary
truncates before reaching it). Split trademark-notice into a partial
(reusable from any template) plus a thin shortcode wrapper, and wire
taxonomy.html to call the partial for pages flagged via a new
trademarkMinio/trademarkAistor frontmatter param. Since this template
is repo-local, not vendored theme code, this fix also covers the
remaining 8 branches once ported there.
@DjP-iX
DjP-iX requested a review from a team as a code owner September 3, 2026 19:10
@bugclerk bugclerk changed the title MinIO/AIStor trademark legal compliance (master) DOCS-2743 / 27 / MinIO/AIStor trademark legal compliance (master) Sep 3, 2026
@bugclerk

bugclerk commented Sep 3, 2026

Copy link
Copy Markdown
Contributor

@github-actions

github-actions Bot commented Sep 3, 2026

Copy link
Copy Markdown
Vale Style Guide Issues (Previous - Click to expand)

Vale Style Guide Issues

📊 Summary: 325 issues found in changed files - 32 errors, 9 warnings, 284 suggestions

Changed files with issues:

content/_archive/COREReleaseNotes/12.0/12.0U4.md (83 issues)

  • Lines 11, 13, 19, 21, 23, 25, 32, 70, 195, 276, 288, 292, 295, 296 - suggestion: Use active voice instead of passive voice
  • Lines 11, 17, 25, 33 - error: 's. T' should have one space.
  • Lines 11, 13, 17, 25, 33, 288 - suggestion: Use single space after periods and single empty lines between paragraphs
  • Lines 15, 17 - suggestion: Spell out 'CORE' on first use
  • Line 17 - suggestion: Avoid using first-person plural (we, us, our)
  • Line 47 - suggestion: Use 'checkout' instead of 'check out'
  • Line 76 - suggestion: Spell out 'MOVED' on first use
  • Line 95 - error: Punctuation should be inside the quotes.
  • Line 109 - error: Avoid contractions. Use 'is not' instead of 'isn't'.
  • Lines 113, 237 - error: Avoid contractions. Use 'cannot' instead of 'Can't'.
  • Line 135 - error: Avoid contractions. Use 'do not' instead of 'don't'.
  • Line 139 - suggestion: Spell out 'UCD' on first use
  • Line 139 - suggestion: Spell out 'MIB' on first use
  • Lines 195, 295, 296 - suggestion: Don't use language (such as 'disabled') that defines people by their disability.
  • Line 205 - suggestion: Spell out 'GET' on first use
  • Line 211 - suggestion: Spell out 'HDD' on first use
  • Lines 211, 241 - suggestion: Spell out 'SMART' on first use
  • Line 223 - suggestion: Spell out 'DPM' on first use
  • Line 225 - suggestion: Spell out 'SSSD' on first use
  • Line 235 - suggestion: Spell out 'CSS' on first use
  • Line 247 - suggestion: Spell out 'EINTR' on first use
  • Line 275 - error: Use 'could' instead of 'may'
  • Lines 276, 288 - suggestion: Avoid using 'will' - use present tense instead of future tense
  • Line 288 - error: Use 'clear' instead of 'uncheck'
  • Line 288 - error: 'g. I' should have one space.
  • Line 296 - error: Use 'login' instead of 'log in'
  • Line 296 - suggestion: Use 'login' instead of 'log in'

content/SCALE/Apps/AppsScreens.md (61 issues)

  • Line 27 - suggestion: Use Oxford comma before 'and' in lists
  • Line 27 - suggestion: Use the Oxford comma in 'screens, Installed and Discover.'.
  • Lines 28, 36, 102, 161, 379 - suggestion: Keep sentences under 30 words
  • Lines 56, 184 - suggestion: Consider 'TrueNAS' instead of 'Docker'
  • Lines 127, 132 - error: Don't add '(s)' to a singular noun. Use plural instead.
  • Lines 131, 134, 153, 154, 161, 175, 192, 220, 261, 269, 284, 302, 323 - suggestion: Use active voice instead of passive voice
  • Lines 155, 156 - suggestion: Use 'signin' instead of 'sign in'
  • Lines 221, 285 - warning: For a general audience, use 'address' rather than 'URL'.
  • Lines 234, 249, 311, 313, 332 - suggestion: Use 'rollback' instead of 'Roll Back'
  • Lines 245, 295, 296, 400, 420 - suggestion: Spell out 'YAML' on first use
  • Line 261 - suggestion: Don't use language (such as 'disabled') that defines people by their disability.
  • Lines 317, 330 - suggestion: Use 'rollback' instead of 'roll back'
  • Lines 322, 326 - suggestion: Use 'rollback' instead of 'Roll back'

content/SCALE/GettingStarted/Migrate/MigratePrep.md (58 issues)

  • Line 19 - warning: Don't use end punctuation in headings.
  • Lines 26, 32 - suggestion: Avoid using first-person plural (we, us, our)
  • Lines 32, 60, 74, 108, 143, 156, 166, 197 - suggestion: Keep sentences under 30 words
  • Line 38 - error: Avoid contractions. Use 'have not' instead of 'haven't'.
  • Lines 43, 194 - error: Don't add '(s)' to a singular noun. Use plural instead.
  • Line 58 - suggestion: Use 'backup' instead of 'back up'
  • Lines 64, 146, 147, 176, 177, 194, 195, 197 - suggestion: Spell out 'UID' on first use
  • Lines 64, 146, 147, 176, 177, 194, 195, 197 - suggestion: Spell out 'GID' on first use
  • Lines 64, 89, 165, 166 - suggestion: Use active voice instead of passive voice
  • Lines 83, 85 - suggestion: Spell out 'CORE' on first use
  • Line 99 - suggestion: Spell out 'LAGG' on first use
  • Line 115 - suggestion: Use 'backup' instead of 'Back up'
  • Line 125 - suggestion: Spell out 'ISO' on first use
  • Line 143 - warning: For a general audience, use 'address' rather than 'URL'.
  • Line 163 - suggestion: Use Oxford comma before 'and' in lists

content/_archive/COREReleaseNotes/12.0/12.0U8.md (53 issues)

  • Lines 12, 18, 37, 39, 43, 88, 128, 177, 187, 191, 192 - suggestion: Use active voice instead of passive voice
  • Line 15 - suggestion: Spell out 'URI' on first use
  • Lines 18, 20 - suggestion: Avoid using first-person plural (we, us, our)
  • Line 20 - suggestion: Avoid using 'will' - use present tense instead of future tense
  • Line 26 - suggestion: Use 'checkout' instead of 'check out'
  • Line 26 - error: Avoid contractions. Use 'do not' instead of 'don't'.
  • Line 26 - error: Avoid contractions. Use 'we are' instead of 'We're'.
  • Line 30 - suggestion: Keep sentences under 30 words
  • Lines 33, 42 - suggestion: Spell out 'VFS' on first use
  • Line 37 - error: Avoid possessive forms ('file's'). Rephrase to avoid using apostrophes for possession.
  • Line 46 - error: Form a negative number with an en dash, not a hyphen.
  • Line 92 - error: Avoid contractions. Use 'cannot' instead of 'can't'.
  • Line 112 - suggestion: Spell out 'WWPN' on first use
  • Line 114 - suggestion: Spell out 'CORE' on first use
  • Line 122 - error: Avoid contractions. Use 'could not' instead of 'couldn't'.
  • Line 124 - suggestion: Spell out 'MIT' on first use
  • Line 128 - warning: Use first person (such as 'me') sparingly.
  • Line 138 - warning: Prefer 'personal digital assistant' over 'agent'.
  • Line 144 - error: Avoid contractions. Use 'does not' instead of 'doesn't'.
  • Lines 177, 191, 192 - suggestion: Don't use language (such as 'disabled') that defines people by their disability.
  • Line 177 - error: Use 'filesystem' instead of 'file system'
  • Line 180 - suggestion: Consider 'TrueNAS' instead of 'Docker'
  • Line 182 - suggestion: Spell out 'SAN' on first use
  • Line 192 - error: Use 'login' instead of 'log in'
  • Line 192 - suggestion: Use 'login' instead of 'log in'

content/_archive/COREReleaseNotes/12.0/12.0U8.1.md (28 issues)

  • Lines 12, 14, 57, 67, 71, 72 - suggestion: Use active voice instead of passive voice
  • Lines 14, 16 - suggestion: Avoid using first-person plural (we, us, our)
  • Line 16 - suggestion: Avoid using 'will' - use present tense instead of future tense
  • Line 22 - suggestion: Use 'checkout' instead of 'check out'
  • Lines 57, 71, 72 - suggestion: Don't use language (such as 'disabled') that defines people by their disability.
  • Line 57 - error: Use 'filesystem' instead of 'file system'
  • Line 60 - suggestion: Consider 'TrueNAS' instead of 'Docker'
  • Line 62 - suggestion: Spell out 'SAN' on first use
  • Line 72 - error: Use 'login' instead of 'log in'
  • Line 72 - suggestion: Use 'login' instead of 'log in'

content/Solutions/Integrations/VeeamImmutability.md (17 issues)

  • Lines 15, 27, 59 - suggestion: Use active voice instead of passive voice
  • Lines 20, 27 - warning: Don't use end punctuation in headings.
  • Line 23 - suggestion: Use 'rollback' instead of 'roll back'
  • Lines 42, 44, 54 - suggestion: Keep sentences under 30 words
  • Line 42 - suggestion: Use Oxford comma before 'and' in lists
  • Line 54 - suggestion: Don't use language (such as 'disabled') that defines people by their disability.

content/References/Copyrights.md (9 issues)

  • Lines 7, 9, 21 - suggestion: Use active voice instead of passive voice
  • Line 13 - suggestion: Use Oxford comma before 'and' in lists
  • Line 15 - suggestion: Spell out 'AWS' on first use
  • Line 38 - suggestion: Spell out 'UNIX' on first use

content/Solutions/MinioCOREtoSCALE.md (8 issues)

  • Lines 14, 17 - suggestion: Keep sentences under 30 words
  • Lines 15, 17 - suggestion: Use active voice instead of passive voice

content/Solutions/MigratingToTrueNAS.md (5 issues)

  • Line 14 - suggestion: Keep sentences under 30 words
  • Line 32 - suggestion: Use Title Case for headings
  • Line 34 - suggestion: Use active voice instead of passive voice
  • Line 38 - warning: Prefer 'cloud' over 'the cloud'.

content/Solutions/_index.md (3 issues)

  • Line 21 - suggestion: Use active voice instead of passive voice
  • Line 22 - error: Avoid possessive forms ('solution's'). Rephrase to avoid using apostrophes for possession.

🔧 To fix: Review the issues above and update your documentation accordingly.

@github-actions

github-actions Bot commented Sep 3, 2026

Copy link
Copy Markdown

Vale Style Guide Issues

📊 Summary: 325 issues found in changed files - 32 errors, 9 warnings, 284 suggestions

Changed files with issues:

content/_archive/COREReleaseNotes/12.0/12.0U4.md (83 issues)

  • Lines 11, 13, 19, 21, 23, 25, 32, 70, 195, 276, 288, 292, 295, 296 - suggestion: Use active voice instead of passive voice
  • Lines 11, 17, 25, 33 - error: 's. T' should have one space.
  • Lines 11, 13, 17, 25, 33, 288 - suggestion: Use single space after periods and single empty lines between paragraphs
  • Lines 15, 17 - suggestion: Spell out 'CORE' on first use
  • Line 17 - suggestion: Avoid using first-person plural (we, us, our)
  • Line 47 - suggestion: Use 'checkout' instead of 'check out'
  • Line 76 - suggestion: Spell out 'MOVED' on first use
  • Line 95 - error: Punctuation should be inside the quotes.
  • Line 109 - error: Avoid contractions. Use 'is not' instead of 'isn't'.
  • Lines 113, 237 - error: Avoid contractions. Use 'cannot' instead of 'Can't'.
  • Line 135 - error: Avoid contractions. Use 'do not' instead of 'don't'.
  • Line 139 - suggestion: Spell out 'UCD' on first use
  • Line 139 - suggestion: Spell out 'MIB' on first use
  • Lines 195, 295, 296 - suggestion: Don't use language (such as 'disabled') that defines people by their disability.
  • Line 205 - suggestion: Spell out 'GET' on first use
  • Line 211 - suggestion: Spell out 'HDD' on first use
  • Lines 211, 241 - suggestion: Spell out 'SMART' on first use
  • Line 223 - suggestion: Spell out 'DPM' on first use
  • Line 225 - suggestion: Spell out 'SSSD' on first use
  • Line 235 - suggestion: Spell out 'CSS' on first use
  • Line 247 - suggestion: Spell out 'EINTR' on first use
  • Line 275 - error: Use 'could' instead of 'may'
  • Lines 276, 288 - suggestion: Avoid using 'will' - use present tense instead of future tense
  • Line 288 - error: Use 'clear' instead of 'uncheck'
  • Line 288 - error: 'g. I' should have one space.
  • Line 296 - error: Use 'login' instead of 'log in'
  • Line 296 - suggestion: Use 'login' instead of 'log in'

content/SCALE/Apps/AppsScreens.md (61 issues)

  • Line 27 - suggestion: Use Oxford comma before 'and' in lists
  • Line 27 - suggestion: Use the Oxford comma in 'screens, Installed and Discover.'.
  • Lines 28, 36, 102, 161, 379 - suggestion: Keep sentences under 30 words
  • Lines 56, 184 - suggestion: Consider 'TrueNAS' instead of 'Docker'
  • Lines 127, 132 - error: Don't add '(s)' to a singular noun. Use plural instead.
  • Lines 131, 134, 153, 154, 161, 175, 192, 220, 261, 269, 284, 302, 323 - suggestion: Use active voice instead of passive voice
  • Lines 155, 156 - suggestion: Use 'signin' instead of 'sign in'
  • Lines 221, 285 - warning: For a general audience, use 'address' rather than 'URL'.
  • Lines 234, 249, 311, 313, 332 - suggestion: Use 'rollback' instead of 'Roll Back'
  • Lines 245, 295, 296, 400, 420 - suggestion: Spell out 'YAML' on first use
  • Line 261 - suggestion: Don't use language (such as 'disabled') that defines people by their disability.
  • Lines 317, 330 - suggestion: Use 'rollback' instead of 'roll back'
  • Lines 322, 326 - suggestion: Use 'rollback' instead of 'Roll back'

content/SCALE/GettingStarted/Migrate/MigratePrep.md (58 issues)

  • Line 19 - warning: Don't use end punctuation in headings.
  • Lines 26, 32 - suggestion: Avoid using first-person plural (we, us, our)
  • Lines 32, 60, 74, 108, 143, 156, 166, 197 - suggestion: Keep sentences under 30 words
  • Line 38 - error: Avoid contractions. Use 'have not' instead of 'haven't'.
  • Lines 43, 194 - error: Don't add '(s)' to a singular noun. Use plural instead.
  • Line 58 - suggestion: Use 'backup' instead of 'back up'
  • Lines 64, 146, 147, 176, 177, 194, 195, 197 - suggestion: Spell out 'UID' on first use
  • Lines 64, 146, 147, 176, 177, 194, 195, 197 - suggestion: Spell out 'GID' on first use
  • Lines 64, 89, 165, 166 - suggestion: Use active voice instead of passive voice
  • Lines 83, 85 - suggestion: Spell out 'CORE' on first use
  • Line 99 - suggestion: Spell out 'LAGG' on first use
  • Line 115 - suggestion: Use 'backup' instead of 'Back up'
  • Line 125 - suggestion: Spell out 'ISO' on first use
  • Line 143 - warning: For a general audience, use 'address' rather than 'URL'.
  • Line 163 - suggestion: Use Oxford comma before 'and' in lists

content/_archive/COREReleaseNotes/12.0/12.0U8.md (53 issues)

  • Lines 12, 18, 37, 39, 43, 88, 128, 177, 187, 191, 192 - suggestion: Use active voice instead of passive voice
  • Line 15 - suggestion: Spell out 'URI' on first use
  • Lines 18, 20 - suggestion: Avoid using first-person plural (we, us, our)
  • Line 20 - suggestion: Avoid using 'will' - use present tense instead of future tense
  • Line 26 - suggestion: Use 'checkout' instead of 'check out'
  • Line 26 - error: Avoid contractions. Use 'do not' instead of 'don't'.
  • Line 26 - error: Avoid contractions. Use 'we are' instead of 'We're'.
  • Line 30 - suggestion: Keep sentences under 30 words
  • Lines 33, 42 - suggestion: Spell out 'VFS' on first use
  • Line 37 - error: Avoid possessive forms ('file's'). Rephrase to avoid using apostrophes for possession.
  • Line 46 - error: Form a negative number with an en dash, not a hyphen.
  • Line 92 - error: Avoid contractions. Use 'cannot' instead of 'can't'.
  • Line 112 - suggestion: Spell out 'WWPN' on first use
  • Line 114 - suggestion: Spell out 'CORE' on first use
  • Line 122 - error: Avoid contractions. Use 'could not' instead of 'couldn't'.
  • Line 124 - suggestion: Spell out 'MIT' on first use
  • Line 128 - warning: Use first person (such as 'me') sparingly.
  • Line 138 - warning: Prefer 'personal digital assistant' over 'agent'.
  • Line 144 - error: Avoid contractions. Use 'does not' instead of 'doesn't'.
  • Lines 177, 191, 192 - suggestion: Don't use language (such as 'disabled') that defines people by their disability.
  • Line 177 - error: Use 'filesystem' instead of 'file system'
  • Line 180 - suggestion: Consider 'TrueNAS' instead of 'Docker'
  • Line 182 - suggestion: Spell out 'SAN' on first use
  • Line 192 - error: Use 'login' instead of 'log in'
  • Line 192 - suggestion: Use 'login' instead of 'log in'

content/_archive/COREReleaseNotes/12.0/12.0U8.1.md (28 issues)

  • Lines 12, 14, 57, 67, 71, 72 - suggestion: Use active voice instead of passive voice
  • Lines 14, 16 - suggestion: Avoid using first-person plural (we, us, our)
  • Line 16 - suggestion: Avoid using 'will' - use present tense instead of future tense
  • Line 22 - suggestion: Use 'checkout' instead of 'check out'
  • Lines 57, 71, 72 - suggestion: Don't use language (such as 'disabled') that defines people by their disability.
  • Line 57 - error: Use 'filesystem' instead of 'file system'
  • Line 60 - suggestion: Consider 'TrueNAS' instead of 'Docker'
  • Line 62 - suggestion: Spell out 'SAN' on first use
  • Line 72 - suggestion: Use 'login' instead of 'log in'
  • Line 72 - error: Use 'login' instead of 'log in'

content/Solutions/Integrations/VeeamImmutability.md (17 issues)

  • Lines 15, 27, 59 - suggestion: Use active voice instead of passive voice
  • Lines 20, 27 - warning: Don't use end punctuation in headings.
  • Line 23 - suggestion: Use 'rollback' instead of 'roll back'
  • Lines 42, 44, 54 - suggestion: Keep sentences under 30 words
  • Line 42 - suggestion: Use Oxford comma before 'and' in lists
  • Line 54 - suggestion: Don't use language (such as 'disabled') that defines people by their disability.

content/References/Copyrights.md (9 issues)

  • Lines 7, 9, 21 - suggestion: Use active voice instead of passive voice
  • Line 13 - suggestion: Use Oxford comma before 'and' in lists
  • Line 15 - suggestion: Spell out 'AWS' on first use
  • Line 38 - suggestion: Spell out 'UNIX' on first use

content/Solutions/MinioCOREtoSCALE.md (8 issues)

  • Lines 14, 17 - suggestion: Keep sentences under 30 words
  • Lines 15, 17 - suggestion: Use active voice instead of passive voice

content/Solutions/MigratingToTrueNAS.md (5 issues)

  • Line 14 - suggestion: Keep sentences under 30 words
  • Line 32 - suggestion: Use Title Case for headings
  • Line 34 - suggestion: Use active voice instead of passive voice
  • Line 38 - warning: Prefer 'cloud' over 'the cloud'.

content/Solutions/_index.md (3 issues)

  • Line 21 - suggestion: Use active voice instead of passive voice
  • Line 22 - error: Avoid possessive forms ('solution's'). Rephrase to avoid using apostrophes for possession.

🔧 To fix: Review the issues above and update your documentation accordingly.

@micjohnson777
micjohnson777 merged commit c7990bd into master Sep 3, 2026
4 checks passed
@micjohnson777
micjohnson777 deleted the DOCS-2743-min-io-legal-compliance-master branch September 3, 2026 19:41
@bugclerk

bugclerk commented Sep 3, 2026

Copy link
Copy Markdown
Contributor

This PR has been merged and conversations have been locked.
If you would like to discuss more about this issue please use our forums or raise a Jira ticket.

@truenas truenas locked as resolved and limited conversation to collaborators Sep 3, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants