fix: storage docs hygiene — broken anchors, typos, absolute URLs, data error#979
Open
Iamfle4ka wants to merge 1 commit into
Open
fix: storage docs hygiene — broken anchors, typos, absolute URLs, data error#979Iamfle4ka wants to merge 1 commit into
Iamfle4ka wants to merge 1 commit into
Conversation
…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>
Contributor
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
keboola-pr-reviewer-bot
left a comment
There was a problem hiding this comment.
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 diffsrc/content/docs/storage/tables/csv-files.md: New in-repo link /components/writers/storage/google-drive/ cannot be verified from this diffsrc/content/docs/storage/byodb/external-buckets/index.md: New anchor /catalog/#enable-sharing cannot be verified from this diff
Suggested reviewers: keboola/docs
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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). Twoneeds_humanfindings 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-featurestables/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-sharingsnowflake-secure-data-sharing/index.md:help.keboola.com/storage/byodb/#main-header→/storage/byodb/Typos (5):
eanbled→enabled,grated→granted,generaly→generally,reigstration→registration,addressess→addressesOther (3):
tables/index.md:126: PK dedup example$60000→$600000(missing zero)tables/index.md:252: Tab character → pipe separator in markdown tablecsv-files.md:81: "is set double quote" → "is set to double quote"csv-files.md:93: "Google Drive Writer" → linked to connector pageFull audit log (Blocks 0/A/B/C + Summary) posted as comment on PRDCT-356. Two
needs_human=yesfindings NOT in this diff:backups.md: Time travel documented as "Snowflake only" but code supports BigQuery tootables/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