1
0
mirror of https://github.com/Unleash/unleash.git synced 2025-06-04 01:18:20 +02:00

docs: Add landing pages for all first and second-level categories.

This commit is contained in:
Thomas Heartman 2022-01-24 13:41:29 +01:00
parent ea0ff8f991
commit 738643eb24

View File

@ -13,7 +13,15 @@ module.exports = {
documentation: [ documentation: [
'user_guide/index', 'user_guide/index',
{ {
'First steps': [ label: 'First steps and tutorials',
type: 'category',
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/unleash_overview',
'user_guide/important-concepts', 'user_guide/important-concepts',
'user_guide/quickstart', 'user_guide/quickstart',
@ -26,38 +34,94 @@ module.exports = {
link: { link: {
type: 'generated-index', type: 'generated-index',
title: 'How-to guides', title: 'How-to guides',
description: 'Step-by-step recipes for you to follow', description: 'Step-by-step recipes for you to follow.',
slug: '/how-to', slug: '/how-to',
}, },
items: [ items: [
{ {
API: ['user_guide/api-token', 'advanced/api_access'], type: 'category',
'Feature toggles, strategies, context': [ link: {
type: 'generated-index',
title: 'How-to: Unleash API',
description: 'Learn how to work with the Unleash API',
slug: '/how-to/api',
},
label: 'API',
items: ['user_guide/api-token', 'advanced/api_access'],
},
{
label: 'Feature toggles, strategies, context',
items: [
'how-to/how-to-add-strategy-constraints', 'how-to/how-to-add-strategy-constraints',
'user_guide/create_feature_toggle', 'user_guide/create_feature_toggle',
'how-to/how-to-define-custom-context-fields', 'how-to/how-to-define-custom-context-fields',
'how-to/how-to-use-custom-strategies', 'how-to/how-to-use-custom-strategies',
], ],
'Users and permissions': [ 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', 'user_guide/user-management',
'how-to/how-to-create-and-assign-custom-project-roles', 'how-to/how-to-create-and-assign-custom-project-roles',
], ],
SSO: [ 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-open-id-connect',
'advanced/sso-saml', 'advanced/sso-saml',
'advanced/sso-saml-keycloak', 'advanced/sso-saml-keycloak',
'advanced/sso-google', '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', label: 'Reference documentation',
type: 'category', 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',
},
collapsible: true, collapsible: true,
items: [ items: [
{ {
'Unleash concepts': [ 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', 'user_guide/activation_strategy',
'advanced/archived_toggles', 'advanced/archived_toggles',
'advanced/audit_log', 'advanced/audit_log',
@ -94,6 +158,17 @@ module.exports = {
'api/admin/state', 'api/admin/state',
'api/admin/strategies', 'api/admin/strategies',
'api/admin/user-admin', 'api/admin/user-admin',
{
type: 'category',
label: 'subcat',
link: {
type: 'generated-index',
title: 'Subcat',
description: 'Lorem ipsum',
slug: '/api/subcat',
},
items: ['api/admin/user-admin'],
},
], ],
'Client API': [ 'Client API': [
'api/client/features', 'api/client/features',
@ -109,8 +184,10 @@ module.exports = {
], ],
}, },
{ {
'Unleash SDKs': [ type: 'category',
'sdks/index', label: 'Unleash SDKs',
link: { type: 'doc', id: 'sdks/index' },
items: [
'sdks/unleash-proxy', 'sdks/unleash-proxy',
{ {
type: 'category', type: 'category',
@ -146,7 +223,18 @@ module.exports = {
href: '/sdks#community-sdks', href: '/sdks#community-sdks',
}, },
], ],
'Deploy and manage Unleash': [ },
{
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/getting_started',
'deploy/configuring_unleash', 'deploy/configuring_unleash',
'deploy/database-setup', 'deploy/database-setup',
@ -186,7 +274,16 @@ module.exports = {
], ],
}, },
{ {
'Topic guides': ['topics/a-b-testing'], label: 'Topic guides',
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'],
}, },
], ],
}; };