Skip to content

Commit 61232ab

Browse files
docs: Upgrade to v4 guide (#1873)
* WIP upgrade to v4 docs * WIP * Upgrade to v4 docs * Add wait for token docs and improve upgrade guide * Added known issues to upgrade guide, and moved the migration section higher up * Update to say "There are no known issues at the moment.” * Docs upgrade guide package version. Need to use exact packages for the CLI to work --------- Co-authored-by: Matt Aitken <[email protected]>
1 parent e714f32 commit 61232ab

File tree

4 files changed

+1210
-16
lines changed

4 files changed

+1210
-16
lines changed

docs/docs.json

+48-12
Original file line numberDiff line numberDiff line change
@@ -18,14 +18,24 @@
1818
"groups": [
1919
{
2020
"group": "Getting started",
21-
"pages": ["introduction", "quick-start", "video-walkthrough", "how-it-works", "limits"]
21+
"pages": [
22+
"introduction",
23+
"quick-start",
24+
"video-walkthrough",
25+
"how-it-works",
26+
"limits"
27+
]
2228
},
2329
{
2430
"group": "Fundamentals",
2531
"pages": [
2632
{
2733
"group": "Tasks",
28-
"pages": ["tasks/overview", "tasks/schemaTask", "tasks/scheduled"]
34+
"pages": [
35+
"tasks/overview",
36+
"tasks/schemaTask",
37+
"tasks/scheduled"
38+
]
2939
},
3040
"triggering",
3141
"runs",
@@ -40,7 +50,12 @@
4050
"errors-retrying",
4151
{
4252
"group": "Wait",
43-
"pages": ["wait", "wait-for", "wait-until", "wait-for-token"]
53+
"pages": [
54+
"wait",
55+
"wait-for",
56+
"wait-until",
57+
"wait-for-token"
58+
]
4459
},
4560
"queue-concurrency",
4661
"versioning",
@@ -84,7 +99,9 @@
8499
},
85100
{
86101
"group": "Development",
87-
"pages": ["cli-dev"]
102+
"pages": [
103+
"cli-dev"
104+
]
88105
},
89106
{
90107
"group": "Deployment",
@@ -95,7 +112,9 @@
95112
"deployment/atomic-deployment",
96113
{
97114
"group": "Deployment integrations",
98-
"pages": ["vercel-integration"]
115+
"pages": [
116+
"vercel-integration"
117+
]
99118
}
100119
]
101120
},
@@ -146,15 +165,20 @@
146165
},
147166
{
148167
"group": "Using the Dashboard",
149-
"pages": ["run-tests", "troubleshooting-alerts", "replaying", "bulk-actions"]
168+
"pages": [
169+
"run-tests",
170+
"troubleshooting-alerts",
171+
"replaying",
172+
"bulk-actions"
173+
]
150174
},
151175
{
152176
"group": "Troubleshooting",
153177
"pages": [
154178
"troubleshooting",
155179
"troubleshooting-debugging-in-vscode",
156180
"upgrading-packages",
157-
"upgrading-beta",
181+
"upgrade-to-v4",
158182
"troubleshooting-uptime-status",
159183
"troubleshooting-github-issues",
160184
"request-feature"
@@ -172,7 +196,11 @@
172196
},
173197
{
174198
"group": "Help",
175-
"pages": ["community", "help-slack", "help-email"]
199+
"pages": [
200+
"community",
201+
"help-slack",
202+
"help-email"
203+
]
176204
}
177205
]
178206
},
@@ -193,7 +221,10 @@
193221
},
194222
{
195223
"group": "Tasks API",
196-
"pages": ["management/tasks/trigger", "management/tasks/batch-trigger"]
224+
"pages": [
225+
"management/tasks/trigger",
226+
"management/tasks/batch-trigger"
227+
]
197228
},
198229
{
199230
"group": "Runs API",
@@ -239,7 +270,9 @@
239270
"groups": [
240271
{
241272
"group": "Introduction",
242-
"pages": ["guides/introduction"]
273+
"pages": [
274+
"guides/introduction"
275+
]
243276
},
244277
{
245278
"group": "Frameworks",
@@ -364,7 +397,10 @@
364397
"href": "https://trigger.dev"
365398
},
366399
"api": {
367-
"openapi": ["openapi.yml", "v3-openapi.yaml"],
400+
"openapi": [
401+
"openapi.yml",
402+
"v3-openapi.yaml"
403+
],
368404
"playground": {
369405
"display": "simple"
370406
}
@@ -539,4 +575,4 @@
539575
"destination": "/management/overview"
540576
}
541577
]
542-
}
578+
}

docs/snippets/upgrade-to-v4-note.mdx

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
<Note>
2+
This feature is only available in the v4 beta. To upgrade to v4, see the [upgrade to v4
3+
docs](/upgrade-to-v4).
4+
</Note>

0 commit comments

Comments
 (0)