Skip to content

PXB-3902 [DOCS] (Feedback) Rendering leftovers, broken links/anchors, typos (8.4) - #531

Merged
alina-derkach-oaza merged 4 commits into
8.4from
audit-fixes-8.4
Oct 14, 2026
Merged

alina-derkach-oaza merged 4 commits into
8.4from
audit-fixes-8.4

Conversation

@alina-derkach-oaza

@alina-derkach-oaza alina-derkach-oaza commented Oct 13, 2026 •

Copy link
Copy Markdown
Collaborator

D68. Rendering leftovers
D69. Links
D70. Typos and grammar

#529

- Resolve bracketed reference links (backup locks, Developer Toolset,
  innodb_file_per_table, Release Lifecycle Overview,
  [xbcloud] section)
- Remove literal markup: mis-indented ```{.text .no-copy} in the
  --check-privileges example
- Fix broken code spans: --innodb-miscellaneous and the xbcloud S3
  option table (<AUTO|2|4>, <AUTO|PATH|DNS> and <name> were swallowed
  as HTML tags; en dashes replaced with --)
- Fix "admontion" typo; fix {.power-number} placement on quickstart-exit
- Remove $ and $# prompts from copyable blocks; use sql fences for SQL
- Add descriptive alt text to diagrams
- Fix synopsis typos (dangling | in xtrabackup synopsis, xbcrypt[OPTIONS])
- Show glossary my.cnf samples as ini code blocks
- Wrap page content in <!--email_off--> so Cloudflare Email Obfuscation
  stops rewriting addresses in code samples to [email protected]

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01EqDFHJJ73F1x3rwWX7Vyzm
- Point Percona Toolkit links (verify-backup, toolkit-version-check and
  others) at docs.percona.com/percona-toolkit; the old percona.com/doc
  URLs redirect to the docs home page
- Replace the ZRM FAQ answer with PMM backup management (zmanda.com
  returns 403) and drop its linkspector ignore rule
- Fix broken anchors
- Update stale hosts: jira.percona.com -> perconadev.atlassian.net,
  OpenStack Swift auth, Azurite on learn.microsoft.com
- Fix ..// relative links in release notes
- Option reference: use a plain page-tracking-merge-gap heading so the
  #page-tracking-merge-gap links resolve
- 8.4.0-1 release notes: drop the dead keyring file plugin anchor (the
  plugin is not supported in 8.4) and the ?h= search parameter

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01EqDFHJJ73F1x3rwWX7Vyzm
@alina-derkach-oaza alina-derkach-oaza changed the title [DOCS] (Feedback) Update PXB docs to resolve GH issues (D68) (8.4) [DOCS] (Feedback) Rendering leftovers, broken links/anchors, stale sample output, compile page, typos (8.4) Oct 13, 2026
- Fix typos reported by codespell: dowload, nuber, Explicity, Varify,
  continer, automaticaly, fixe (where present in this series)
- Remove doubled words ("for for", "moves the the")
- Fix grammar: "set up in quickly", "the-- encrypt-key-file",
  "Use supply"

"suceeded" in the log-enhancements sample is left as is: it is verbatim
xtrabackup output (keyring_components.cc).

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01EqDFHJJ73F1x3rwWX7Vyzm
@alina-derkach-oaza
alina-derkach-oaza temporarily deployed to audit-fixes-8.4 - percona-xtrabackup-docs-8.4 PR #531 October 13, 2026 16:36 — with Render Destroyed
@alina-derkach-oaza alina-derkach-oaza changed the title [DOCS] (Feedback) Rendering leftovers, broken links/anchors, stale sample output, compile page, typos (8.4) PXB-3902 [DOCS] (Feedback) Rendering leftovers, broken links/anchors, typos (8.4) Oct 13, 2026

@patrickbirch patrickbirch left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

ok

@patrickbirch patrickbirch left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

ok

@alina-derkach-oaza
alina-derkach-oaza merged commit c321152 into 8.4 Oct 14, 2026
1 check passed
@alina-derkach-oaza
alina-derkach-oaza deleted the audit-fixes-8.4 branch October 14, 2026 15:52

This branch was successfully deployed

No deployments
audit-fixes-8.4 - percona-xtrabackup-docs-8.4 PR #531 — 1d5e23af Deployed Oct 13, 2026 by alina-derkach-oaza
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.

2 participants