Skip to content

fix: storage docs hygiene — broken anchors, typos, absolute URLs, data error - #979

Merged
jordanrburger merged 3 commits into
mainfrom
devin/1782131822-prdct-356-storage-audit
Jun 29, 2026
Merged

fix: storage docs hygiene — broken anchors, typos, absolute URLs, data error#979
jordanrburger merged 3 commits into
mainfrom
devin/1782131822-prdct-356-storage-audit

Conversation

@Iamfle4ka

Copy link
Copy Markdown
Collaborator

Jira issue(s): PRDCT-356

Changes:

Code-accuracy audit of all 16 pages under src/content/docs/storage/. This PR contains only safe, unambiguous fixes (no content rewrites, no restructuring). Two needs_human findings are documented in the audit log on PRDCT-356 but not included here.

Broken anchors (3):

  • buckets/index.md: #backend-properties#storage-backend-types-and-features
  • tables/index.md: #native-datatypes → removed (page exists, anchor doesn't)
  • tables/uploads.md: #events → removed (heading doesn't exist on tables page)

Absolute URLs → relative (3):

  • external-buckets/index.md: help.keboola.com/storage/byodb//storage/byodb/
  • external-buckets/index.md: help.keboola.com/catalog/#enable-sharing/catalog/#enable-sharing
  • snowflake-secure-data-sharing/index.md: help.keboola.com/storage/byodb/#main-header/storage/byodb/

Typos (5):

  • eanbledenabled, gratedgranted, generalygenerally, reigstrationregistration, addressessaddresses

Other (3):

  • tables/index.md:126: PK dedup example $60000$600000 (missing zero)
  • tables/index.md:252: Tab character → pipe separator in markdown table
  • csv-files.md:81: "is set double quote" → "is set to double quote"
  • csv-files.md:93: "Google Drive Writer" → linked to connector page

Full audit log (Blocks 0/A/B/C + Summary) posted as comment on PRDCT-356. Two needs_human=yes findings NOT in this diff:

  1. backups.md: Time travel documented as "Snowflake only" but code supports BigQuery too
  2. tables/index.md: Column naming rules partially inaccurate (columns don't allow dashes; max 64 chars)

Release Notes

Justification, description

Documentation hygiene fixes for storage section — broken anchors, typos, absolute URLs converted to relative, data error in example.

Plans for Customer Communication

N/A

Impact Analysis

N/A — doc-only changes, no code changes

Deployment Plan

N/A — merges to main, auto-deploys

Rollback Plan

N/A

Post-Release Support Plan

N/A

Link to Devin session: https://app.devin.ai/sessions/b8189d4dbed8480187c51e8b5a0dd329
Requested by: @Iamfle4ka

…a error

Fixes PRDCT-356

- Fix broken anchor #backend-properties → #storage-backend-types-and-features (buckets)
- Fix broken anchor #native-datatypes → remove anchor (tables)
- Fix broken anchor #events → remove anchor (uploads)
- Fix data error in PK dedup example: $60000 → $600000 (tables)
- Fix typo: eanbled → enabled (tables)
- Fix malformed table: tab → pipe separator (tables)
- Fix missing word: 'is set double quote' → 'is set to double quote' (csv-files)
- Add link to Google Drive data destination connector (csv-files)
- Fix http → https for developers.keboola.com (uploads)
- Fix absolute URLs help.keboola.com → relative paths (external-buckets x2, snowflake-sharing)
- Fix typos: grated, generaly, reigstration, addressess (external-buckets)

Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
@Iamfle4ka Iamfle4ka self-assigned this Jun 22, 2026
@linear

linear Bot commented Jun 22, 2026

Copy link
Copy Markdown

PRDCT-356

@devin-ai-integration

Copy link
Copy Markdown
Contributor

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment, CI, and merge conflict monitoring

@vercel

vercel Bot commented Jun 22, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
connection-docs Ready Ready Preview, Comment Jun 29, 2026 4:04pm

Request Review

@Iamfle4ka
Iamfle4ka marked this pull request as ready for review June 22, 2026 13:15

@keboola-pr-reviewer-bot keboola-pr-reviewer-bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Verdict: needs_human (risk 2/5) · profile docs

Three in-repo link targets introduced by this PR cannot be verified from the diff alone.

Concerns:

  • src/content/docs/storage/buckets/index.md: Replacement anchor /storage/#storage-backend-types-and-features cannot be verified from this diff
  • src/content/docs/storage/tables/csv-files.md: New in-repo link /components/writers/storage/google-drive/ cannot be verified from this diff
  • src/content/docs/storage/byodb/external-buckets/index.md: New anchor /catalog/#enable-sharing cannot be verified from this diff

Suggested reviewers: keboola/docs

@devin-ai-integration devin-ai-integration Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

✅ Devin Review: No Issues Found

Devin Review analyzed this PR and found no bugs or issues to report.

Open in Devin Review

@jordanrburger
jordanrburger merged commit 148ce14 into main Jun 29, 2026
3 checks passed
@jordanrburger
jordanrburger deleted the devin/1782131822-prdct-356-storage-audit branch June 29, 2026 16:04
Iamfle4ka pushed a commit that referenced this pull request Aug 5, 2026
The second code-accuracy finding from the June storage audit, and the one #979
deliberately left out as needs_human. The audit reports that /storage/tables/
is wrong for COLUMN names specifically: that dashes are rejected by
ColumnNameValidator.php, and that a column name is capped at 64 characters while
a table name allows 96 -- neither limit documented.

That validator lives in the private keboola/connection repo. I could not confirm
any of it from public sources (searched the public keboola org, php-table-backend-utils,
storage-api-php-client), so the user-facing sentence is left EXACTLY as it was
rather than reversed on the strength of an audit note.

Added a VERIFY(owner) explaining the contested claim and why it matters: if dashes
really are invalid for columns, that sentence actively misleads anyone naming one.
Someone with connection access can settle it in a minute.

Verified: build clean (306 pages); audit-phase2 unchanged at 45 broken links /
0 missing images. No user-visible text changed in this commit.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
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.

3 participants