Write documentation for migrating workflow code
维护者通常 1 天内回复
评估
这个 Issue 还没有评估数据。
描述
Objective
Document how a user can migrate a workflow from one OpenFn project to another by copying its YAML on Lightning.
Scope
- In scope: Copying workflow YAML between projects via the Lightning UI (export from source, paste into target).
Required Sections
- Overview — one paragraph: what YAML migration is, when to use it, what it does not carry over (credentials, run history, webhook URLs).
- Prerequisites
- Access to both source and target projects
- Matching adaptor versions available on the target instance.
- Steps
- Open the source workflow and export/copy its YAML
- Open the target project and create a new workflow (or open the workflow editor)
- Paste the YAML, review the diff, confirm deploy
- Screenshots for each step
- What gets migrated vs. what doesn't
- Table: jobs, triggers, edges, workflow structure (migrated) vs. credentials, run history, webhook URLs, collaborators (not migrated).
- Reconnecting credentials on the target
- Credentials are referenced by name/ID; show how to recreate or remap them in the target project
- Verification checklist
- Workflow appears in target, adaptor versions resolved, trigger reconfigured, one test run completes
- Common pitfalls
- Adaptor version mismatch
- Stale credential references
Acceptance Criteria
- UI steps documented with screenshots
- Explicit list of what does and does not transfer with the YAML
- Credential-remapping steps included
- Verification checklist a user can run through in under 5 minutes
- Common pitfalls section with at least the 2 cases above
- Linked from the Workflows index page
- 主要语言
- JavaScript
- 星标
- 25
- 派生
- 22
- 平均合并
- 1 天 3 小时
- 30 天内合并 PR
- 56
环境准备
- 没有 Dockerfile 或 Docker Compose 文件
- 有 Pull Request 模板
- 没有贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
OpenFn/docs 的其他 Issue
-
难度 2/5 1-3 小时 新手友好度 76/100
维护者通常 1 天内回复
-
Update deployment docs可能已有人在做 @taylordowns2000 于 10 天前认领。 未关闭
OpenFn/docs#924 · 2 条评论 · 已指派 1 人 ·
维护者通常 1 天内回复
-
Review and update Manage User Credential page可能已有人在做 @mtuchi 于 25 天前认领。 未关闭
维护者通常 1 天内回复
-
难度 4/5 3-5 天 新手友好度 65/100
维护者通常 1 天内回复
-
难度 3/5 1-2 天 新手友好度 45/100
维护者通常 1 天内回复
相似的 Issue
-
Clinic sharing: fast sync refusal message suggests Delete Data, which only developer builds have未关闭bug
难度 2/5 1-3 小时 新手友好度 78/100
avniproject/avni-client#2228 ·
-
bug confirmed issue
难度 2/5 1-3 小时 新手友好度 68/100
open-webui/open-webui#33196 · 2 条评论 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 76/100
fable-compiler/Fable#5157 ·
维护者通常 1 天内回复
-
New tool: PaperBanana可能已有人在做 @github-actions 今天认领。 未关闭submission triage
难度 1/5 1 小时以内 新手友好度 75/100
kausalflow/tools#243 · 1 条评论 ·
维护者通常 1 天内回复
-
area: apple-music area: build-release bug effort: small priority: high
难度 2/5 1-3 小时 新手友好度 82/100
ChristianTabor/Argon#32 ·
维护者通常 1 天内回复