Skip to content

PRDCT-486: Storage section rework — unified method + live-verify - #1010

Draft
Iamfle4ka wants to merge 5 commits into
mainfrom
PRDCT-359-storage-section
Draft

PRDCT-486: Storage section rework — unified method + live-verify#1010
Iamfle4ka wants to merge 5 commits into
mainfrom
PRDCT-359-storage-section

Conversation

@Iamfle4ka

Copy link
Copy Markdown
Collaborator

Storage section under the unified section-at-a-time method

Reworks the Storage section (16 pages) page-by-page: structure → form → live-verify against the running platform (project 6015, read-only inspection).

What changed (per commit)

  1. Split the Tables frankenstein. The 413-line /storage/tables/ page mixed basics/aliases/metadata with a ~300-line primary-key + incremental-loading/processing reference. That reference now lives at /storage/tables/incremental-loading/ ("Primary Keys & Incremental Loading") with all original anchor slugs preserved. All 41 inbound links across the docs were updated; #aliases (7) and #metadata (3) links stay on the Tables page. Nav entry added, sidebar regenerated.
  2. Live-verified UI fixes + owner flags on the six core pages (hub, buckets, tables, files, jobs, uploads, backups).
  3. Descriptions for the nine specialist pages (csv-files, data-types, data-streams + OTLP, byodb, byobq, external datasets, secure data sharing, bucket exposure). All 16 pages now have description frontmatter (previously zero did).

Live-verified in-product

  • ✅ Storage tabs: Tables & Buckets / Files / Data Streams / Storage Jobs / Events — docs said "Tables tab" and "Files section"; fixed.
  • ✅ Bucket detail opens by clicking the bucket name — docs described a hover → "Bucket detail" menu that doesn't exist; fixed.
  • ✅ Table detail tabs: Overview / Schema / Events / Data Sample / Snapshots / Usage. Three-dots menu: Export table, Load, Share Table, Restore, Create snapshot, Create alias table, Create new workspace, Copy to existing workspace, Delete rows, Truncate table, Delete table.
  • ❌→fixed: docs claimed Export lives in an "Action tab" — there is no such tab; it's Export table in the three-dots menu.
  • ❌→fixed: "Delete Rows" menu label is Delete rows; steps now say Storage → Tables & Buckets.

Flagged for owner review (TODO(human-review))

  • 2 GB upload limit and 15-day file expiry (files)
  • One-writer-per-table limitation (jobs)
  • Time travel Snowflake-only + retention-limit reference (backups)
  • PAYG-defaults-to-BigQuery + MT/KBDB/BYODB backend claims (index)
  • _timestamp semantics for native-types tables (incremental-loading)
  • Bucket Exposure BETA + BigQuery-only (bucket-exposure)

Out of scope

The cross-site "Storage overview" merge with dev-docs /overview/ needs write access to keboola/developers-docs — tracked separately.

Verification

  • npm run build clean (259 pages).
  • node scripts/audit-phase2.mjs: MISSING IMAGES 0; broken internal links = pre-existing only (/404, /workspace/table-export, /ai/kai-assistant/ — the last is fixed in PRDCT-482: AI section rework (kai/ai) — unified method + live-verify #1007).
  • Built HTML checked: all 7 moved anchors resolve on the new page; #aliases/#metadata still on /storage/tables/.

Draft — do not merge. Owner sign-off needed on the flagged facts.

🤖 Generated with Claude Code

Nikita and others added 3 commits July 9, 2026 01:53
The 413-line Tables page mixed basics/aliases/metadata with a 300-line
primary-key + incremental-loading/processing reference. That reference
moves to /storage/tables/incremental-loading/ (anchors preserved); the
Tables page keeps a summary + link. All 41 inbound links across the
docs updated to the new page; #aliases and #metadata links unchanged.
Nav entry added, sidebar regenerated.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Verified in-product: Storage tabs are Tables & Buckets / Files / Data
Streams / Storage Jobs / Events; bucket detail opens on click (no hover
menu); table three-dots menu labels (Export table, Create snapshot,
Delete rows, Truncate table). Fixed the false 'Action tab' export claim
and 'Tables tab'/'Files section' wording. Flagged deep facts
TODO(human-review): 2GB/15-day file limits, one-writer-per-table,
time-travel Snowflake-only + retention, PAYG/backend-type claims.
Adds description frontmatter to these six pages.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
csv-files, data-types, data-streams (+OTLP), byodb, byobq, external
datasets, secure data sharing, bucket exposure (+ BETA flag).

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@vercel

vercel Bot commented Jul 8, 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 Aug 8, 2026 12:08am

Request Review

@linear-code

linear-code Bot commented Jul 8, 2026

Copy link
Copy Markdown

PRDCT-359

PRDCT-486

@Iamfle4ka Iamfle4ka changed the title docs(storage): Storage section rework — unified method + live-verify PRDCT-486: Storage section rework — unified method + live-verify Jul 10, 2026
@Iamfle4ka

Copy link
Copy Markdown
Collaborator Author

⚠️ Do not merge the backups.md description as written — it hard-codes a fact that is wrong.

This PR adds:

description: Back up and restore Storage tables — time-travel restore on the Snowflake backend and table snapshots on all backends.

plus <!-- TODO(human-review): confirm time travel is still Snowflake-only … -->.

That TODO has now been answered, and the answer is no. keboola/php-storage-driver-bigquery ships src/Handler/Table/Create/CreateTableFromTimeTravelHandler.php, which runs CREATE TABLE <dest> AS SELECT * FROM <src> FOR SYSTEM_TIME AS OF <timestamp>, covered by two active (non-skipped) functional tests asserting real row counts. The audit's own citation, Bucket.php:backendSupportsTimeTravel(), says the same. Time travel restore works on BigQuery.

Why this matters more than a normal stale sentence: a description feeds the meta tag, site search, and the Ask Kai corpus. Merging this would take an error that currently lives in one body paragraph and propagate it into the page's machine-readable summary.

#1083 (june-audit-fixes) corrects the body copy on both storage/tables/backups.md and storage/tables/index.md. Whichever of the two PRs lands second needs to reconcile:

Flagging rather than editing this branch, since it has been idle 24 days and I do not want to disturb work someone may be mid-way through.

…ection

# Conflicts:
#	src/content/docs/storage/buckets/index.md
#	src/content/docs/storage/data-streams/data-streams.md
#	src/content/docs/storage/index.md
#	src/content/docs/storage/jobs/index.md
#	src/content/docs/storage/tables/index.md
#	src/content/docs/transformations/mappings/index.md
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.

1 participant