This repository has been archived by the owner on Dec 9, 2019. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 19
/
Copy pathcontent.index.js
395 lines (394 loc) · 13.4 KB
/
content.index.js
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
const guideListConfig = {
sections: [
{
id: 'intro',
name: 'Quick Start',
guides: [
{
title: 'Quick Start Guide',
description: 'Adding Skygear to your iOS, Android and web apps',
baseUrl: '/guides/intro/quickstart/',
languages: ['ios', 'android', 'js'],
},
{
title: 'Integrating frameworks',
description: 'Integrating Webpack, Ionic and Angular',
baseUrl: '/guides/intro/integration/',
languages: ['js'],
},
],
},
{
id: 'auth',
name: 'User Authentication',
guides: [
{
title: 'User Authentication Basics',
description: 'User Log-in/Log-out, user access tokens, email and password managements',
baseUrl: '/guides/auth/basics/',
languages: ['ios', 'android', 'js'],
},
{
title: 'Social Login',
description: 'Third-party login, e.g. Facebook, Google',
baseUrl: '/guides/auth/social-login/',
languages: ['ios', 'android', 'js'],
},
{
title: 'Authenticate with a custom auth system',
description: 'Integrate authentication server to Skygear using JWT',
baseUrl: '/guides/auth/custom-token/',
languages: ['ios', 'android', 'js'],
},
{
title: 'User Profile Best Practices',
description: 'Saving and retrieving custom profile attributes',
baseUrl: '/guides/auth/user-profile/',
languages: ['ios', 'android', 'js'],
},
{
title: 'Disabling User Accounts',
description: 'Learn how to disable a user account',
baseUrl: '/guides/auth/disable/',
languages: ['ios', 'android', 'js'],
},
{
title: 'Password Policy',
description: 'Enforce stronger passwords with Password Policy',
baseUrl: '/guides/auth/password-policy/',
languages: ['ios', 'android', 'js'],
},
{
title: 'Email Verification',
description: 'Verify user email',
baseUrl: '/guides/auth/email-verification/',
languages: ['ios', 'android', 'js'],
},
{
title: 'SMS Verification',
description: 'Verify user phone number via SMS',
baseUrl: '/guides/auth/sms-verification/',
languages: ['ios', 'android', 'js'],
},
],
},
{
id: 'cloud-db',
name: 'Cloud Database',
guides: [
{
title: 'Cloud Database Basics',
description: 'Intro to Skygear records, ' +
' public and private database and Skygear data type',
baseUrl: '/guides/cloud-db/basics/',
languages: ['ios', 'android', 'js'],
},
{
title: 'Basic CRUD',
description: 'Create, update, query and delete Skygear records',
baseUrl: '/guides/cloud-db/crud/',
languages: ['ios', 'android', 'js'],
},
{
title: 'More About Queries',
description: 'Query conditions, paginations and record counts',
baseUrl: '/guides/cloud-db/queries/',
languages: ['ios', 'android', 'js'],
},
{
title: 'Relational Records',
description: 'Create and query Skygear references, eager loading',
baseUrl: '/guides/cloud-db/relational-records/',
languages: ['ios', 'android', 'js'],
},
{
title: 'File Storage',
description: 'Create and query files in Skygear',
baseUrl: '/guides/cloud-db/files/',
languages: ['ios', 'android', 'js'],
},
{
title: 'Location, Auto-increment sequence fields',
description: 'Create and query locations and sequence',
baseUrl: '/guides/cloud-db/data-types/',
languages: ['ios','android','js'],
},
{
title: 'Cached query',
description: 'Working with offline storage',
baseUrl: '/guides/cloud-db/offline-storage/',
languages: ['ios', 'android', 'js'],
},
{
title: 'Query Subscriptions',
description: 'Subscribe to database data changes from the client',
baseUrl: '/guides/cloud-db/query-subscription/',
languages: ['ios', 'android', 'js'],
},
],
},
{
id: 'acl',
name: 'Access Control',
guides: [
{
title: 'Access Control Basics',
description: 'Intro to access control in Skygear',
baseUrl: '/guides/acl/acl-overview/',
languages: ['ios', 'android', 'js'],
},
{
title: 'Record-based ACL',
description: 'Set the ACL of a record type',
baseUrl: '/guides/acl/record-acl/',
languages: ['ios', 'android', 'js'],
},
{
title: 'Field-based ACL',
description: 'Set the ACL of a record field',
baseUrl: '/guides/acl/field-acl',
languages: [''],
},
],
},
{
id: 'chat',
name: 'Real-time Chat',
guides: [
{
title: 'Quick Start for Chat',
description: 'Adding Skygea Chat to your iOS, Android and web apps',
baseUrl: '/guides/chat/quick-start/',
languages: ['ios', 'android', 'js'],
},
{
title: 'Skygear Chat Basics',
description: 'Creating chatrooms, sending and receiving messages with Chat APIs',
baseUrl: '/guides/chat/basics/',
languages: ['ios', 'android', 'js'],
},
{
title: 'Skygear Chat Data Models',
description: 'Data models of Skygear Chat',
baseUrl: '/guides/chat/models',
languages: ['']
},
{
title: 'Chat Event Hooks',
description: 'Running codes upon chat event such as message sent',
baseUrl: '/guides/chat/cloud-event-hook/',
languages: ['python', 'js']
},
{
title: 'Skygear Chat UI Kit',
description: 'UIKit of Skygear Chat',
baseUrl: '/guides/chat/uikit/',
languages:['ios', 'android'],
},
],
},
{
id: 'pubsub',
name: 'Skygear PubSub',
guides: [
{
title: 'PubSub Basics',
description: 'Adding the publish-subscribe functioality to your' +
' app with Skygear',
baseUrl: '/guides/pubsub/basics/',
languages: ['ios', 'android', 'js'],
},
],
},
{
id: 'push-notifications',
name: 'Push Notifications',
guides: [
{
title: 'Setting up Push Notification',
description: 'Setting Push Notification with FCM or APN',
baseUrl: '/guides/push-notifications/config/',
languages: ['ios', 'android'],
},
{
title: 'Push Notification Basics',
description: 'Sending push notifications with Skygear',
baseUrl: '/guides/push-notifications/basics/',
languages: ['ios', 'android', 'js'],
},
{
title: 'Migrate to FCM from GCM',
description: 'Migrate existing GCM push notification to FCM',
baseUrl: '/guides/push-notifications/android-migrate-fcm',
languages: [''],
}
],
},
{
id: 'cms',
name: 'CMS',
guides: [
{
title: 'CMS Quick Start',
description: 'Learn how to configure the CMS for your business users.',
baseUrl: '/guides/cms/cms-basics',
languages: [''],
},
{
title: 'Configuring the CMS Record Page',
description: 'Enable your admins to view, update, and create records.',
baseUrl: '/guides/cms/cms-records',
languages: [''],
},
{
title: 'CMS Field Types',
description: 'Field types in CMS refers to the UI presentation of a field. Learn more.',
baseUrl: '/guides/cms/cms-field-type',
languages: [''],
},
{
title: 'Configuring Imports and Exports',
description: 'Enable your admins to import and export records.',
baseUrl: '/guides/cms/cms-import',
languages: [''],
},
{
title: 'Configuring the User Management Dashboard',
description: 'Manage your users with the user management dashboard.',
baseUrl: '/guides/cms/cms-user',
languages: [''],
},
],
},
{
id: 'cloud-function',
name: 'Cloud Functions',
guides: [
{
title: 'Introduction to Cloud Functions',
description: 'The first step to using the Skygear cloud functions' +
' to have your codes running on Skygear server',
baseUrl: '/guides/cloud-function/intro-and-deployment',
languages: [''],
},
{
title: 'Trigger by Database Event',
description: 'Running codes upon database events such as' +
' creating, updating or deleting records',
baseUrl: '/guides/cloud-function/database-hooks/',
languages: ['python', 'js'],
},
{
title: 'Trigger by Schedule',
description: 'Executing your server codes at specified time' +
' or intervals',
baseUrl: '/guides/cloud-function/scheduled-tasks/',
languages: ['python', 'js'],
},
{
title: 'Trigger by Client SDK',
description: 'Lambda functions can be called from the SDKs' +
' to execute your custom codes on Skygear server',
baseUrl: '/guides/cloud-function/lambda/',
languages: ['python', 'js'],
},
{
title: 'Trigger by HTTP Endpoint',
description: 'Creating your own HTTP endpoint so that external' +
' applications can send GET/POST and other requests to your app',
baseUrl: '/guides/cloud-function/http-endpoint/',
languages: ['python', 'js'],
},
{
title: 'Trigger by Restful HTTP Endpoint',
description: 'Creating your own set of restful HTTP endpoint easily' +
' through cloud functions',
baseUrl: '/guides/cloud-function/restful-http-endpoint/',
languages: ['python'],
},
{
title: 'Trigger by Chat Events',
description: 'Running codes upon chat event such as message sent',
baseUrl: '/guides/chat/cloud-event-hook/',
languages: ['python', 'js']
},
{
title: 'Serving Static Assets',
description: 'Methods to make your static assets such as images' +
' accessible with a URL',
baseUrl: '/guides/cloud-function/static-assets/',
languages: ['python', 'js'],
},
{
title: 'APIs in Cloud Functions',
description: 'Calling Skygear API, using database connections,' +
' pubsub, push notifications, and using the master key to' +
' impersonate user for the admin',
baseUrl: '/guides/cloud-function/calling-skygear-api/',
languages: ['python', 'js'],
},
{
title: 'Authenticating Users',
description: 'Getting the authenticated user ID from the cloud' +
' functions, and resetting the password of a user',
baseUrl: '/guides/cloud-function/authenticating-users/',
languages: ['python', 'js'],
},
{
title: 'Error Handling',
description: 'Error handling in cloud functions',
baseUrl: '/guides/cloud-function/error-handling/',
languages: ['python', 'js'],
},
],
},
{
id: 'advanced',
name: 'Advanced',
guides: [
{
title: 'Deploy Skygear Local Server',
description: 'Reference for deploy Skygear server',
// no trailing slash if language not applicable
baseUrl: '/guides/advanced/server',
languages: [''],
},
{
title: 'Skygear Database Schema',
description: 'More details about database record tables, reserved columns,' +
' schema migration and reserved tables',
// no trailing slash if language not applicable
baseUrl: '/guides/advanced/database-schema',
languages: [''],
},
{
title: 'Custom Authentication Provider',
description: 'User authentication with third-party service',
// no trailing slash if language not applicable
baseUrl: '/guides/advanced/auth-provider/',
languages: ['python'],
},
{
title: 'Error Handling in the SDKs',
description: 'Handle error with error codes in SDK when operations fail',
// no trailing slash if language not applicable
baseUrl: '/guides/advanced/sdk-error-handling/',
languages: ['ios', 'android', 'js'],
},
{
title: 'User Relations',
description: 'Creating Friends/Followers relationships',
baseUrl: '/guides/social-network/basics/',
languages: ['ios', 'android', 'js'],
},
{
title: 'Record Storage',
description: 'Working with the Skygear offline database',
baseUrl: '/guides/advanced/record-storage/',
languages: ['ios'],
},
],
},
],
};
export default guideListConfig;