Repository navigation
docs(import): point the import guide at the wizard it never mentioned (#799) - #888
Merged
Merged
Conversation
…#799) `guides/importing-your-data` documented one route in — curl and the JS SDK — for an action that takes three clicks on a list view. The wizard is not a separate feature: it reads the saved mappings whose target object is the list view you started from, so `crm_account_import` / `crm_contact_import` / `crm_lead_import` — the three the page already tabulates — turn up there under Saved mapping. Adds a fork at the top and one short signposting section on the in-app route (Import toolbar button, Upload / Mapping / Preview, and the mapping from the wizard's buttons back to this page's steps: Validate data = Step 2's dry run, large file = Step 3's job, History / Undo import = Step 4). Click-by-click steps stay in `guides/import-and-export` and are linked, not repeated — the two pages divide the work rather than each describing the wizard in its own words (#763). API content untouched. All three locales. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01VHrPAGEgFDoHjphqYG4BMa
|
The latest updates on your projects. Learn more about Vercel for GitHub. |
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.
Fixes #799
content/docs/guides/importing-your-data.mdx三语从头到尾只有一条路(curl + JS SDK),而列表视图上真实存在的导入向导正是靠该页那三个映射工作的。本 PR 按 issue 自带建议,在该页加一个岔路口与一节简短指路的界面路线,API 内容一字未动。前提复核(基线
origin/main@0d3f3216)grep -in "wizard|list view|toolbar|向导|精靈|列表视图|清單檢視"零命中:17-22:17-22(zh-Hans / zh-Hant:15-19,表体同为该三行)import-and-export向导章节### The in-app import wizard在:21-32(PR #797 所写):225「Where to go next」→/docs/guides/import-and-export;对侧回链在import-and-export.mdx:17 / :32 / :41ui-components-*.js:import:Import/导入/インポート、importTitle:Import from CSV/从 CSV 文件导入stepUpload:Upload/上传、stepMapping:Mapping/字段映射、stepPreview:Preview/预览Validate data、history:History/历史、undoImport:Undo import/撤销导入ImportWizard懒加载@objectstack/console/dist/assets/plugin-grid-*.js内同源链路在
@objectstack/console/dist/assets/data-adapter-*.js里实测为:即 issue 所述
listImportMappings→meta.getItems('mapping')→ 按targetObject过滤,一字不差。同一文件里savedMappingHint写的是「映射“{{name}}”将在服务端应用重命名 + 转换 + 类型强转,列映射为只读」——新节里那句只读的说法即据此,不是推断。结论:premise 完全成立,无一项漂移。
改了什么(三语对照)
两处,共 +69 行,其余不动。
1. 开头岔路口(紧接首段之后、映射表之前)
各自适合谁:向导 = 一次性文件、想先亲眼过一遍再写入、不用令牌不用 curl;API = 脚本化或反复执行,且严格试运行报告、逐行错误码、撤销调用只在这条路上。
2. 新节(映射表之后、
Step 1之前,各 12 行)## From the list view — the import wizard## 从列表视图进 —— 导入向导## 從清單檢視進 —— 匯入精靈节内四段,全部是指路而非教程:
targetObject列出映射,所以它们正好出现在这三个列表视图的 Saved mapping / 已保存的映射 里;选中后重命名、值转换、类型强转在服务端执行,列映射转为只读。Validate data= 第 2 步试运行,大文件 = 第 3 步同一个后台作业,History→Undo import= 第 4 步(撤销窗口限制一并适用)。guides/import-and-export。zh 术语按语言包与该页既有写法:
字段映射/对应、已保存的映射/已儲存的對應、校验数据/驗證資料、撤销导入/復原匯入、潜在客户/潛在客戶均与 console i18n 及import-and-export中译对齐。分工遵守(#763 教训)
⛔ 向导步骤没有在两页各写一遍。本页新节 12 行里没有任何一处展开操作细节:不讲拖放/粘贴,不讲
Download template,不讲置信度读数,不讲写入模式的三个选项,不讲Match on选字段——这些全部只在import-and-export里,本节以一句话链过去。反向也守住了:runAutomations: false、逐行错误码、50,000 行作业上限、5,000 行撤销上限等界面上看不到的东西,仍然只在本页。分工落定为:
import-and-export讲界面与导出全景,importing-your-data讲 API 细节与已知限制,互相链接。⛔
content/docs/guides/import-and-export.mdx(及其两个译本)一个字节都没动 —— PR #797 刚落,其中的回链本就指向本页,无需配合修改。⛔ 未动src/**、未动content/docs/releases/、未加守卫、未升级@objectstack/*。文件面:
content/docs/guides/importing-your-data{,.zh-Hans,.zh-Hant}.mdx+.changeset/import-wizard-path.md,无第五个文件。验证
共享锁 +
NODE_OPTIONS=--max-old-space-size=4096下依次执行,六项全绿:pnpm validateData: 17 Objects 344 Fields/Logic: 24 Flows;5 条 ⚠ 均为既有审批与字段组告警pnpm typechecktsc --noEmit无输出pnpm buildArtifact: dist/objectstack.json (1921.4 KB)pnpm test --maxWorkers=2Test Files 66 passed (66)/Tests 1587 passed | 1 skipped (1588)pnpm lint13 warning(s), 14 suggestion(s)—— 全为既有 approval / naming 告警pnpm hygiene✓ no raw control bytes in first-party files/✓ source hygiene cleantest输出里的✗ source hygiene: scanned director(y|ies) missing: .changeset是source-hygiene-scan-surface.test.ts元测试自身打到 stderr 的预期文案,该文件计入 66 passed。test/import-mappings.test.ts:233那组「docs describe what ships」断言(三个 mapping 名、三个模板名、data.undoImportJob、/import/jobs、以及每个模板表头都要在正文出现)在本次纯新增下依旧全过——新节没有移动或改写任何被断言的文本。控制字节自扫:改动的 4 个文件
grep -naP '[\x00-\x08\x0b\x0c\x0e-\x1f]'退出码 1(零命中),pnpm hygiene的 403 个 content/.changeset 文件扫描同样干净。changeset
.changeset/import-wizard-path.md('hotcrm': patch)内站内路径一律反引号,无 markdown 链接形式(#797 约定)。正文内的站内链接按规范写成 markdown 链接。Generated by Claude Code