-
-
Notifications
You must be signed in to change notification settings - Fork 656
/
sidebars.js
282 lines (279 loc) · 11 KB
/
sidebars.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
/**
* Creating a sidebar enables you to:
- create an ordered group of docs
- render a sidebar for each doc of that group
- provide next/previous navigation
The sidebars can be generated from the filesystem, or explicitly defined here.
Create as many sidebars as you want.
*/
module.exports = {
documentation: [
'user_guide/index',
{
label: 'First steps and tutorials',
type: 'category',
collapsed: false,
link: {
type: 'generated-index',
title: 'First steps',
description: 'Learn how and where to get started with Unleash.',
slug: '/tutorials',
},
items: [
'user_guide/unleash_overview',
'user_guide/important-concepts',
'user_guide/quickstart',
],
},
{
label: 'How-to guides',
collapsed: false,
type: 'category',
link: {
type: 'generated-index',
title: 'How-to guides',
description: 'Step-by-step recipes for you to follow.',
slug: '/how-to',
},
items: [
{
type: 'category',
link: {
type: 'generated-index',
title: 'How-to: Unleash API',
description: 'Learn how to work with the Unleash API',
slug: '/how-to/api',
},
label: 'Using the APIs',
items: ['user_guide/api-token', 'advanced/api_access'],
},
{
label: 'Feature toggles, strategies, context',
items: [
'how-to/how-to-add-strategy-constraints',
'user_guide/create_feature_toggle',
'how-to/how-to-define-custom-context-fields',
'how-to/how-to-use-custom-strategies',
'how-to/how-to-capture-impression-data'
],
type: 'category',
link: {
type: 'generated-index',
title: 'How-to: general Unleash tasks',
description:
'Guides for how to perform general Unleash tasks.',
slug: '/how-to/misc',
},
},
{
label: 'Users and permissions',
items: [
'user_guide/user-management',
'how-to/how-to-create-and-assign-custom-project-roles',
],
type: 'category',
link: {
type: 'generated-index',
title: 'How-to: users and permissions',
description: 'Users and permission how-to guides.',
slug: '/how-to/users-and-permissions',
},
},
{
label: 'Single Sign-On (SSO)',
items: [
'advanced/sso-open-id-connect',
'advanced/sso-saml',
'advanced/sso-saml-keycloak',
'advanced/sso-google',
],
type: 'category',
link: {
type: 'generated-index',
title: 'How-to: Single Sign-On',
description: 'Single Sign-On how-to guides.',
slug: '/how-to/sso',
},
},
,
],
},
{
label: 'Reference documentation',
collapsed: false,
type: 'category',
link: {
type: 'generated-index',
title: 'Reference documentation',
description:
'Technical reference documentation relating to Unleash, including APIs, SDKs, Unleash concepts and deployment.',
slug: '/reference',
},
items: [
{
type: 'category',
link: { type: 'doc', id: 'addons/index' },
items: [
'addons/datadog',
'addons/slack',
'addons/teams',
'addons/webhook',
],
label: 'Addons',
},
{
type: 'category',
link: { type: 'doc', id: 'api/index' },
label: 'APIs',
items: [
{
'Admin API': [
'api/admin/addons',
'api/admin/context',
'api/admin/events',
'api/admin/feature-toggles-v2',
'api/admin/feature-types',
'api/admin/features',
'api/admin/features-archive',
'api/admin/metrics',
'api/admin/projects',
'api/admin/state',
'api/admin/strategies',
'api/admin/user-admin',
],
'Client API': [
'api/client/features',
'api/client/metrics',
'api/client/register',
],
'System API': [
'api/internal/internal',
'api/internal/health',
],
},
'api/open_api',
],
},
{
type: 'category',
label: 'Client SDKs',
link: { type: 'doc', id: 'sdks/index' },
items: [
{
type: 'category',
label: 'Server-side SDKs',
items: [
'sdks/go_sdk',
'sdks/java_sdk',
'sdks/node_sdk',
'sdks/php_sdk',
'sdks/python_sdk',
'sdks/ruby_sdk',
{
type: 'link',
href: 'https://github.com/unleash/unleash-client-rust',
label: 'Rust SDK',
},
'sdks/dot_net_sdk',
],
},
{
type: 'category',
label: 'Client-side SDKs',
items: [
'sdks/android_proxy_sdk',
'sdks/proxy-ios',
'sdks/proxy-javascript',
'sdks/proxy-react',
],
},
{
type: 'link',
label: 'Community SDKs',
href: '/sdks#community-sdks',
},
],
},
{
type: 'category',
link: {
type: 'generated-index',
title: 'Deployment and management of Unleash',
description:
'All you need to learn how to deploy and manage your own Unleash instance.',
slug: '/deploy',
},
label: 'Deploy and manage Unleash',
items: [
'deploy/getting_started',
'deploy/configuring_unleash',
'deploy/database-setup',
'deploy/database_backup',
'deploy/email',
'deploy/google_auth',
'deploy/import_export',
'deploy/migration_guide',
'deploy/securing_unleash',
],
},
{
type: 'category',
label: 'Integrations',
link: { type: 'doc', id: 'integrations/integrations' },
items: [
{
'Jira Server': [
'integrations/jira_server_plugin_installation',
'integrations/jira_server_plugin_usage',
],
},
,
],
},
{
type: 'category',
link: {
type: 'generated-index',
title: 'Unleash concepts',
description:
'Documents describing the inner parts of Unleash.',
slug: '/reference/concepts',
},
label: 'Unleash concepts',
items: [
'user_guide/activation_strategy',
'advanced/archived_toggles',
'advanced/audit_log',
'advanced/impression-data',
'advanced/custom_activation_strategy',
'user_guide/environments',
'advanced/feature_toggle_types',
'advanced/toggle_variants',
'user_guide/projects',
'user_guide/rbac',
'advanced/enterprise-authentication',
'advanced/stickiness',
'advanced/strategy_constraints',
'advanced/tags',
'user_guide/technical_debt',
'user_guide/unleash_context',
'sdks/unleash-proxy',
],
},
],
},
{
label: 'Topic guides',
collapsed: false,
type: 'category',
link: {
type: 'generated-index',
title: 'Topic guides',
description:
'Discussions, explanations, and explorations regarding topics related to Unleash.',
slug: '/topics',
},
items: ['topics/a-b-testing'],
},
],
};