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
- フォーク
- 21
- 平均マージ
- 1日 5時間
- マージ済み PR（30日）
- 51
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートあり
- コントリビューションガイドなし
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
OpenFn/docs のほかの issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 76/100
メンテナーはふだん 1 日以内に返信
-
Update deployment docs対応中かも @taylordowns2000 が 1 日前に担当しました。 オープン
OpenFn/docs#924 · コメント 2 件 · 担当者 1 名 ·
メンテナーはふだん 1 日以内に返信
-
Review and update Manage User Credential page対応中かも @mtuchi が 17 日前に担当しました。 オープン
メンテナーはふだん 1 日以内に返信
-
難易度 4/5 3〜5日 初心者へのやさしさ 65/100
メンテナーはふだん 1 日以内に返信
-
難易度 3/5 1〜2日 初心者へのやさしさ 45/100
メンテナーはふだん 1 日以内に返信
似ている issue
-
effort:low model:light plan planner:fable-5-1 test-quality tests
難易度 2/5 1〜3時間 初心者へのやさしさ 88/100
メンテナーはふだん 1 日以内に返信
-
area: agent area: theme help wanted lane: free-agent roadmap size: S status: needs-brief type: layout type: task
難易度 2/5 1〜3時間 初心者へのやさしさ 60/100
arminazimi/slipway#64 ·
-
release:v5.34
難易度 1/5 1時間未満 初心者へのやさしさ 90/100
Jason-Vaughan/TangleClaw#2469 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
-
hacktoberfest help wanted skip-changelog
難易度 2/5 1〜3時間 初心者へのやさしさ 85/100
wassim-azi/agy-powerline#74 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 67/100
MadeBaruna/paimon-moe#696 ·