Skip to content

DOCS-2743 / 24.10 / MinIO/AIStor trademark legal compliance (24.10) - #4779

Merged
tonyriv3 merged 6 commits into
24.10from
DOCS-2743-minio-trademark-24.10-impl
Sep 4, 2026
Merged

DOCS-2743 / 24.10 / MinIO/AIStor trademark legal compliance (24.10)#4779
tonyriv3 merged 6 commits into
24.10from
DOCS-2743-minio-trademark-24.10-impl

Conversation

@DjP-iX

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

Copy link
Copy Markdown
Contributor

Summary

Part of DOCS-2743 (MinIO Legal Compliance), branch 24.10. Marks the first mention of MinIO with bold+™+correct casing and adds the required attribution footer (MinIO is a trademark of the MinIO Corporation.) to every page on this branch that names MinIO to a reader.

  • layouts/shortcodes/trademark-notice.html — new self-contained shortcode (recreated independently, byte-identical to the versions on 26/25.10/25.04).
  • content/GettingStarted/Migrate/MigratePrep.md — first mention marked (**MinIO™**); three later mentions in the same paragraph, including two markdown link-texts, are untouched. Attribution appended.
  • static/includes/AppsHostIP.md — this branch's actual first mention lives in a shared include (identical gap to 25.04, confirmed in advance). Fixed the casing (Minio**MinIO™**) once, in the shared file, since it's the true reading-order-first mention on both consuming pages.
  • content/SCALEUIReference/Apps/_index.md — attribution appended. This branch also has a second shared include (static/includes/AppsInstallWizardSettings.md) with a real, already-correctly-cased, later mention — confirmed via reading-order trace to need no edit.
  • content/GettingStarted/SCALEReleaseNotes.md — attribution appended (this page never names MinIO directly; the mention only reaches it via the shared include above).

What wasn't needed on this branch (all confirmed, not assumed):

  • No Copyrights.md, no content/_archive/, no client-side changelog-CSV tables.
  • No taxonomy (.Summary) exposure — the Apps and Migrate tag-listing summaries both truncate before reaching the relevant content.
  • No {{< children >}} exposure — no parent _index.md's rendered description mentions MinIO.
  • static/api/{core,scale}_websocket_api.html and static/includes/TNDataCollection.md — auto-generated/lowercase non-prose examples.
  • One accepted non-issue (carried forward from 25.04): static/includes/AppsHostIP.md's raw static-passthrough copy shows the mark without adjacent attribution — an already-ruled, site-wide structural characteristic unrelated to this ticket.

An independent final whole-branch review (Opus) caught one markup regression during implementation — SCALEReleaseNotes.md was missing a blank line before the appended shortcode, causing Goldmark to nest the notice's <p> inside the page's closing paragraph (invalid HTML, no compliance impact since the text was still present and visible). Fixed and independently re-reviewed.

Test plan

  • Clean hugo --gc --minify build: exit 0, 0 ERROR lines.
  • All three affected pages render exactly 1 attribution sentence and exactly 1 mark each; all later/second mentions (including two markdown link-texts on MigratePrep.md and the AppsInstallWizardSettings.md mention) are byte-for-byte untouched.
  • Full transitive include-graph trace (DOM-offset enumeration, not just source order) confirms the shared mention is genuinely first on both consuming pages.
  • Site-wide source sweep and mark-without-attribution sweep (across all of public/, not just .html) — only the known, accepted raw-passthrough non-issue remains.
  • Print view, RSS/XML aggregation (co-presence checked per-item, not just per-file), and taxonomy pages all checked.
  • Independent final whole-branch review (Opus): found and required the blank-line fix above; fix independently re-reviewed and approved.

🤖 Generated with Claude Code

@DjP-iX
DjP-iX requested a review from a team as a code owner September 4, 2026 13:52
@bugclerk bugclerk changed the title MinIO/AIStor trademark legal compliance (24.10) DOCS-2743 / 24.10 / MinIO/AIStor trademark legal compliance (24.10) Sep 4, 2026
@bugclerk

bugclerk commented Sep 4, 2026

Copy link
Copy Markdown
Contributor

@github-actions

github-actions Bot commented Sep 4, 2026

Copy link
Copy Markdown

Vale Style Guide Issues

📊 Summary: 320 issues found in changed files - 21 errors, 1 warnings, 298 suggestions

Changed files with issues:

content/GettingStarted/SCALEReleaseNotes.md (232 issues)

  • Lines 38, 175, 190, 541 - error: Don't use 'backend'. See the A-Z word list for details.
  • Line 41 - error: 'from' is repeated!
  • Lines 45, 52, 55, 57, 73, 77, 79, 97, 98, 99, 127, 148, 163, 173, 182, 184, 191, 197, 199, 204, 211, 217, 234, 240, 243, 253, 260, 265, 266, 272, 274, 280, 285, 286, 287, 288, 289, 290, 291, 292, 293, 301, 304, 307, 316, 321, 333, 342, 359, 376, 382, 387, 389, 390, 391, 394, 403, 404, 406, 408, 412, 415, 422, 428, 442, 448, 455, 472, 481, 494, 497, 499, 514, 520, 528, 534, 541, 559, 567, 572, 581, 588, 602 - suggestion: Use active voice instead of passive voice
  • Lines 45, 373, 496, 498 - suggestion: Spell out 'YAML' on first use
  • Line 57 - suggestion: Use 'rollback' instead of 'roll back'
  • Line 108 - suggestion: Use Title Case for headings
  • Lines 119, 288 - suggestion: Use 'backup' instead of 'back up'
  • Line 180 - error: Use 'could' instead of 'May'
  • Line 190 - suggestion: Spell out 'RPC' on first use
  • Line 204 - suggestion: Spell out 'ZED' on first use
  • Line 216 - suggestion: Use Oxford comma before 'and' in lists
  • Line 223 - suggestion: Spell out 'OCI' on first use
  • Line 239 - suggestion: Avoid using first-person plural (we, us, our)
  • Lines 249, 250, 400, 401 - error: Punctuation should be inside the quotes.
  • Line 277 - suggestion: Spell out 'UAF' on first use
  • Line 285 - error: Avoid contractions. Use 'does not' instead of 'doesn't'.
  • Lines 288, 541 - suggestion: Don't use language (such as 'disabled') that defines people by their disability.
  • Lines 293, 295, 298, 299 - error: Don't add '(es)' to a singular noun. Use plural instead.
  • Line 296 - error: Don't add '(s)' to a singular noun. Use plural instead.
  • Lines 319, 338 - suggestion: Spell out 'AIO' on first use
  • Line 410 - error: Avoid contractions. Use 'are not' instead of 'aren't'.
  • Line 453 - suggestion: Spell out 'UTC' on first use
  • Lines 518, 545 - suggestion: Spell out 'RAIDZ' on first use
  • Line 549 - suggestion: Spell out 'SMART' on first use
  • Line 551 - suggestion: Spell out 'CORE' on first use
  • Line 551 - error: Avoid possessive forms ('feature's'). Rephrase to avoid using apostrophes for possession.
  • Line 565 - suggestion: Spell out 'UID' on first use

content/GettingStarted/Migrate/MigratePrep.md (37 issues)

  • Lines 3, 11, 30, 35, 37, 50, 54, 58, 60, 62, 64, 66, 75, 80, 85, 87, 92, 94 - suggestion: Spell out 'CORE' on first use
  • Line 20 - warning: Don't use end punctuation in headings.
  • Line 29 - suggestion: Avoid using first-person plural (we, us, our)
  • Line 52 - suggestion: Use 'backup' instead of 'back up'
  • Lines 54, 66, 80, 87 - suggestion: Keep sentences under 30 words
  • Line 71 - suggestion: Spell out 'LAGG' on first use
  • Line 87 - suggestion: Use active voice instead of passive voice
  • Line 89 - suggestion: Use 'backup' instead of 'Back up'
  • Line 94 - suggestion: Spell out 'ISO' on first use

content/SCALEUIReference/Apps/_index.md (36 issues)

  • Line 17 - suggestion: Use Oxford comma before 'and' in lists
  • Line 17 - suggestion: Use the Oxford comma in 'screens, Installed and Discover.'.
  • Lines 18, 25, 58, 72, 90, 199 - suggestion: Keep sentences under 30 words
  • Lines 44, 92, 117 - suggestion: Consider 'TrueNAS' instead of 'Docker'
  • Lines 90, 102, 113, 123, 174, 223, 292 - suggestion: Use active voice instead of passive voice
  • Line 113 - suggestion: Don't use language (such as 'disabled') that defines people by their disability.
  • Lines 248, 268 - suggestion: Spell out 'YAML' on first use

static/includes/AppsHostIP.md (15 issues)

  • Lines 3, 10, 251 - suggestion: Use active voice instead of passive voice
  • Line 13 - error: Use 'could' instead of 'May'
  • Line 22 - suggestion: Spell out 'DVR' on first use
  • Line 114 - suggestion: Spell out 'III' on first use
  • Line 132 - suggestion: Spell out 'IPFS' on first use
  • Line 161 - suggestion: Spell out 'RED' on first use
  • Line 171 - suggestion: Spell out 'NGX' on first use
  • Line 208 - suggestion: Spell out 'TFTPD' on first use
  • Line 208 - suggestion: Spell out 'HPA' on first use
  • Line 234 - error: Don't use 'backend'. See the A-Z word list for details.

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

@tonyriv3 tonyriv3 added the Technical Writer Review (TR) A technical writer is reviewing the PR. label Sep 4, 2026
@tonyriv3
tonyriv3 merged commit 3fb18f0 into 24.10 Sep 4, 2026
2 checks passed
@tonyriv3
tonyriv3 deleted the DOCS-2743-minio-trademark-24.10-impl branch September 4, 2026 14:55
@bugclerk

bugclerk commented Sep 4, 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 4, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

no-time-tracked Technical Writer Review (TR) A technical writer is reviewing the PR.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants