Repository navigation
Expand file tree
/
Copy pathconfig.ts
More file actions
434 lines (430 loc) · 11.7 KB
/
Copy pathconfig.ts
File metadata and controls
434 lines (430 loc) · 11.7 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
const siteConfig = {
gatsby: {
pathPrefix: '/docs',
siteUrl: 'https://www.prisma.io',
titlePrefix: '',
titleSuffix: ' | Prisma Docs',
},
redirects: [
// Added this object for redirect because gatsby filters through the redirects key in gatsby-browser.js.
// This object will create a "dummy" page in percy, creating a 404 page of `/foo/index`
{
from: '/foo',
to: '/bar',
},
],
header: {
secondLevelHeaderMenuItems: [
{
text: 'Get Started',
to: '/getting-started',
type: 'bucket',
bucketName: '/100-getting-started',
},
{
text: 'Concepts',
to: '/concepts',
type: 'bucket',
bucketName: '/200-concepts',
},
{
text: 'Guides',
to: '/guides',
type: 'bucket',
bucketName: '/300-guides',
},
{
text: 'Reference',
to: '/reference',
type: 'bucket',
bucketName: '/400-reference',
},
{
text: 'Prisma Data Platform',
to: '/data-platform',
type: 'bucket',
bucketName: '/800-data-platform',
},
{ text: 'About', to: '/about', type: 'bucket', bucketName: '/600-about' },
],
search: {
indexName: process.env.GATSBY_ALGOLIA_INDEX_NAME,
algoliaAppId: process.env.GATSBY_ALGOLIA_APP_ID,
algoliaSearchKey: process.env.GATSBY_ALGOLIA_SEARCH_KEY,
algoliaAdminKey: process.env.GATSBY_ALGOLIA_ADMIN_API_KEY,
},
},
homepage: {
SummaryLinkData: {
gettingStarted: 'getting-started',
readyToRun: 'https://github.com/prisma/prisma-examples',
slack: 'https://slack.prisma.io/',
git: 'https://github.com/prisma',
buttons: [
{
text: 'Getting started',
url: 'getting-started',
special: true,
icon: 'DoubleArrow',
},
{
text: 'Example projects',
url: 'https://github.com/prisma/prisma-examples',
special: false,
icon: null,
},
],
},
GeneralLinkData: [
{
categoryName: 'Overview',
icon: 'OverviewIcon',
links: [
{
text: 'What is Prisma',
url: 'concepts/overview/what-is-prisma',
codeBlock: false,
},
{
text: 'Why Prisma?',
url: 'concepts/overview/why-prisma',
codeBlock: false,
},
{
text: 'Should you use Prisma?',
url: 'concepts/overview/should-you-use-prisma',
codeBlock: false,
},
{
text: 'Prisma in your stack',
url: 'concepts/overview/prisma-in-your-stack',
codeBlock: false,
},
{
text: 'Under the hood',
url: 'concepts/components/prisma-engines',
codeBlock: false,
},
],
},
{
categoryName: 'Components',
icon: 'ComponentsIcon',
links: [
{
text: 'Prisma schema',
url: 'concepts/components/prisma-schema',
codeBlock: false,
},
{
text: 'Prisma Client',
url: 'concepts/components/prisma-client',
codeBlock: false,
},
{
text: 'Prisma Migrate',
url: 'concepts/components/prisma-migrate',
codeBlock: false,
},
{
text: 'Introspection',
url: 'concepts/components/introspection',
codeBlock: false,
},
{
text: 'Prisma CLI',
url: 'concepts/components/prisma-cli',
codeBlock: false,
},
{
text: 'Prisma Studio',
url: 'concepts/components/prisma-studio',
codeBlock: false,
},
{
text: 'Preview features',
url: 'concepts/components/preview-features',
codeBlock: false,
},
],
},
{
categoryName: 'Database Connectors',
icon: 'DatabaseIcon',
links: [
{
text: 'PostgreSQL',
url: 'concepts/database-connectors/postgresql',
codeBlock: false,
},
{
text: 'MySQL',
url: 'concepts/database-connectors/mysql',
codeBlock: false,
},
{
text: 'MongoDB',
url: 'concepts/database-connectors/mongodb',
codeBlock: false,
},
{
text: 'SQL Server',
url: 'concepts/database-connectors/sql-server',
codeBlock: false,
},
{
text: 'SQLite',
url: 'concepts/database-connectors/sqlite',
codeBlock: false,
},
{
text: 'CockroachDB',
url: 'concepts/database-connectors/cockroachdb',
codeBlock: false,
},
],
},
{
categoryName: 'More',
icon: 'MoreIcon',
links: [
{
text: 'Editor setup',
url: 'guides/development-environment/editor-setup',
codeBlock: false,
},
{
text: 'Codemod',
url: 'guides/upgrade-guides/upgrading-versions/codemods',
codeBlock: false,
},
{
text: 'Telemetry',
url: 'concepts/more/telemetry',
codeBlock: false,
},
{
text: 'Comparing Prisma',
url: 'concepts/more/comparisons',
codeBlock: false,
},
],
},
],
GuideText: 'Guides for building and deploying applications with Prisma.',
GuideLinkData: [
{
title: 'Developing with Prisma Migrate',
color: '#48BB78',
small: false,
content: 'Get started with Prisma Migrate.',
url: 'guides/database/developing-with-prisma-migrate',
},
{
title: 'Performance and optimization',
color: '#38B2AC',
small: true,
content: 'Tune your queries and monitor your application.',
url: 'guides/performance-and-optimization',
},
{
title: 'Working with your database',
color: '#4299E1',
small: true,
content:
'Guides for common database workflow such as configuring constraints or cascading deletes.',
url: 'guides/database',
},
{
title: 'Adopting Prisma',
color: '#9F7AEA',
small: true,
content: 'Migrate to Prisma from other ORMs.',
url: 'guides/migrate-to-prisma',
},
{
title: 'Upgrading to Prisma',
color: '#ED64A6',
small: true,
content: 'Upgrade to Prisma from Prisma 1 or Graphcool.',
url: 'guides/upgrade-guides',
},
{
title: 'Deploying Prisma apps',
color: '#667EEA',
small: false,
content:
'Deploy a Node.js application with Prisma Client to platforms like Vercel, AWS Lambda, Netlify, and Heroku.',
url: 'guides/deployment',
},
],
ReferenceText:
'Reference documentation for Prisma Client, the Prisma Schema Language (PSL), the Prisma CLI, and supported database providers.',
ReferenceLinkData: [
{
categoryName: 'Prisma Reference',
mainUrl: 'reference',
icon: 'Schema',
links: [
{
text: 'Prisma Client API reference',
url: 'reference/api-reference/prisma-client-reference',
codeBlock: false,
},
{
text: 'Prisma schema reference',
url: 'reference/api-reference/prisma-schema-reference',
codeBlock: false,
},
{
text: 'Prisma error reference',
url: 'reference/api-reference/error-reference',
codeBlock: false,
},
],
},
{
categoryName: 'CLI Commands',
mainUrl: 'reference/api-reference/command-reference',
icon: 'CLI',
links: [
{
text: 'introspect',
url: 'reference/api-reference/command-reference#introspect',
codeBlock: true,
},
{
text: 'migrate',
url: 'reference/api-reference/command-reference#prisma-migrate',
codeBlock: true,
},
{
text: 'db',
url: 'reference/api-reference/command-reference#db',
codeBlock: true,
},
],
},
{
categoryName: 'Database',
mainUrl: 'reference/database-reference',
icon: 'DbLink',
links: [
{
text: 'Features matrix',
url: 'reference/database-reference/database-features',
codeBlock: false,
},
{
text: 'Connection URLs',
url: 'reference/database-reference/connection-urls',
codeBlock: false,
},
{
text: 'Supported databases',
url: 'reference/database-reference/supported-databases',
codeBlock: false,
},
],
},
],
MoreUsefulLinks: [
{
text: 'About the docs ',
url: 'about/prisma-docs/about-the-docs',
codeBlock: false,
},
{
text: 'Prisma style guide',
url: 'about/prisma-docs/style-guide',
codeBlock: false,
},
{
text: 'Ask a question on Github',
url: 'guides/database/troubleshooting-orm#need-help',
codeBlock: false,
},
{
text: 'Create a bug report',
url: 'guides/database/troubleshooting-orm',
codeBlock: false,
},
{
text: 'Submit a feature request',
url: 'guides/database/troubleshooting-orm',
codeBlock: false,
},
{
text: 'Slack',
url: 'https://slack.prisma.io/',
codeBlock: false,
},
{
text: 'FAQ',
url: 'about/prisma/faq',
},
{
text: 'Limitations',
url: 'about/prisma/limitations',
codeBlock: false,
},
{
text: 'Community',
url: 'https://www.prisma.io/community',
codeBlock: false,
},
{
text: 'Roadmap',
url: 'about/prisma/roadmap',
codeBlock: false,
},
{
text: 'ORM Releases and maturity levels',
url: 'about/prisma/releases',
codeBlock: false,
},
{
text: 'Platform Releases and maturity levels',
url: 'data-platform/about/releases',
codeBlock: false,
},
],
},
siteMetadata: {
title: 'Prisma Documentation | Concepts, Guides, and Reference',
description:
"Get started with Prisma in the official documentation, and learn more about all Prisma's features with reference documentation, guides, and more.",
keywords: 'Docs, prisma, 2.0',
docsLocation: 'https://github.com/prisma/docs/tree/main/content',
twitter: {
site: '@prisma',
creator: '@prisma',
image: '/social/docs-social.png',
},
og: {
site_name: 'Prisma',
type: 'website',
image: {
alt: 'Database tools for modern developers',
height: '630',
type: 'image/png',
url: '/social/docs-social.png',
width: '1200',
},
},
SpecialPaths: ['prisma-cli', 'deployment', 'sql-views'],
},
feedback: {
sentimentUrl: '/docs/api/sentiment',
feedbackUrl: '/docs/api/feedback',
},
sidebar: {
tablet_menu_split: ['04-guides', '05-more'], // Slugs for top level folders which should appear in right pane on tablet
},
footer: {
newsletter: {
text: 'Stay up to date with the latest features and changes to Prisma',
},
},
}
export default siteConfig