Skip to content

Commit 6b7d880

Browse files
docs(migration): state the target versions — migrate 0.x straight to latest 2.x
The migration guide framed the target only as '2.0'. Clarify that a legacy (0.x) pipeline migrates directly to the latest 2.x release (currently 2.3) in a single upgrade — no stepping through 2.0 -> 2.1 -> 2.2 -> 2.3. '2.0' in the guide is the migration surface (type system, codecs, unified stores); 2.1-2.3 build on it with no extra migration steps. Retitle to 'Migrate to DataJoint 2.x' (H1 + nav).
1 parent d945a73 commit 6b7d880

2 files changed

Lines changed: 20 additions & 3 deletions

File tree

mkdocs.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ nav:
9999
- Manage Large Data: how-to/manage-large-data.md
100100
- Clean Up Storage: how-to/garbage-collection.md
101101
- Maintenance:
102-
- Migrate to 2.0: how-to/migrate-to-v20.md
102+
- Migrate to 2.x: how-to/migrate-to-v20.md
103103
- Alter Tables: how-to/alter-tables.md
104104
- Backup and Restore: how-to/backup-restore.md
105105
- Testing:

src/how-to/migrate-to-v20.md

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,27 @@
1-
# Migrate to DataJoint 2.0
1+
# Migrate to DataJoint 2.x
22

3-
Upgrade existing pipelines from legacy DataJoint (pre-2.0) to DataJoint 2.0+.
3+
Upgrade existing pipelines from legacy DataJoint (the pre-2.0 `0.x` series)
4+
directly to the latest DataJoint 2.x — currently **2.3**.
45

56
> **This guide is optimized for AI coding assistants.** Point your AI agent at this
67
> document and it will execute the migration with your oversight.
78
9+
!!! tip "Which version do I migrate to?"
10+
11+
Migrate **straight to the latest 2.x release** (currently 2.3) — there is no
12+
need to step through 2.0 → 2.1 → 2.2 → 2.3. A single upgrade takes a `0.x`
13+
pipeline all the way to 2.3.
14+
15+
Everything this guide calls "2.0" is the **migration surface** — the type
16+
system, explicit codecs, and unified `stores` introduced in 2.0. Later
17+
releases build on it without adding migration steps: **2.1** added the
18+
PostgreSQL backend and configurable diagram layout, **2.2** added the jobs
19+
layer and diagram operations, and **2.3** added the upstream/provenance API.
20+
Installing the latest release gives you all of them.
21+
22+
Complete the migration while on **2.3 or earlier**: the `datajoint.migrate`
23+
helper is scheduled for removal in 2.4/2.5.
24+
825
!!! warning "Temporary module"
926

1027
The `datajoint.migrate` module is provided temporarily to assist with migration and is scheduled for removal in DataJoint 2.4 or 2.5. We recommend completing your migration while on DataJoint 2.3 or earlier.

0 commit comments

Comments
 (0)