/**
* 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: [
'about-the-docs',
{
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: [
'tutorials/unleash-overview',
'tutorials/important-concepts',
'tutorials/quickstart',
],
},
{
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/the-anatomy-of-unleash',
'topics/a-b-testing',
'topics/managing-constraints',
'topics/proxy-hosting',
'topics/data-collection',
],
},
{
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: 'Unleash API guides',
items: [
'how-to/how-to-create-api-tokens',
'how-to/how-to-create-personal-access-tokens',
'how-to/how-to-create-project-api-tokens',
'how-to/how-to-create-service-accounts',
'how-to/how-to-download-login-history',
'how-to/how-to-use-the-admin-api',
'how-to/how-to-enable-openapi',
],
},
{
type: 'category',
link: {
type: 'generated-index',
title: 'How-to: The Unleash Proxy',
description: 'Learn how to work with the Unleash Proxy',
slug: '/how-to/proxy',
},
label: 'Unleash Proxy guides',
items: ['how-to/how-to-run-the-unleash-proxy'],
},
{
label: 'Feature toggles, strategies, context',
items: [
'how-to/how-to-add-strategy-constraints',
'how-to/how-to-capture-impression-data',
'how-to/how-to-create-feature-toggles',
'how-to/how-to-define-custom-context-fields',
'how-to/how-to-use-custom-strategies',
'how-to/how-to-schedule-feature-releases',
'how-to/how-to-synchronize-unleash-instances',
],
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: 'Environments',
items: ['how-to/how-to-clone-environments'],
type: 'category',
link: {
type: 'generated-index',
title: 'How-to: environments',
description: 'Environments how-to guides.',
slug: '/how-to/env',
},
},
{
label: 'Users and permissions',
items: [
'how-to/how-to-add-users-to-unleash',
'how-to/how-to-create-and-assign-custom-project-roles',
'how-to/how-to-create-and-manage-user-groups',
'how-to/how-to-set-up-group-sso-sync',
],
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: [
'how-to/how-to-add-sso-open-id-connect',
'how-to/how-to-add-sso-saml',
'how-to/how-to-add-sso-saml-keycloak',
'how-to/how-to-add-sso-google',
'how-to/how-to-add-sso-azure-saml',
'how-to/how-to-setup-sso-keycloak-group-sync',
],
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: 'reference/addons/index' },
items: [
'reference/addons/datadog',
'reference/addons/slack',
'reference/addons/teams',
'reference/addons/webhook',
],
label: 'Addons',
},
{
type: 'category',
label: 'APIs',
items: [
{
label: 'OpenAPI docs',
collapsed: true,
type: 'category',
link: {
title: 'Unleash Server APIs',
type: 'generated-index',
description:
'Generated API docs based on the Unleash OpenAPI schema. For the time being, some additional info can also be found in the older API docs.',
slug: '/reference/api/unleash',
},
items: require('./docs/reference/api/unleash/sidebar.js'),
},
{
type: 'category',
label: 'Legacy API docs',
link: {
type: 'doc',
id: 'reference/api/legacy/unleash/index',
},
items: [
{
'Admin API': [
'reference/api/legacy/unleash/admin/addons',
'reference/api/legacy/unleash/admin/context',
'reference/api/legacy/unleash/admin/events',
'reference/api/legacy/unleash/admin/features-v2',
'reference/api/legacy/unleash/admin/feature-types',
'reference/api/legacy/unleash/admin/features',
'reference/api/legacy/unleash/admin/archive',
'reference/api/legacy/unleash/admin/metrics',
'reference/api/legacy/unleash/admin/projects',
'reference/api/legacy/unleash/admin/segments',
'reference/api/legacy/unleash/admin/state',
'reference/api/legacy/unleash/admin/strategies',
'reference/api/legacy/unleash/admin/tags',
'reference/api/legacy/unleash/admin/user-admin',
],
'Client API': [
'reference/api/legacy/unleash/client/features',
'reference/api/legacy/unleash/client/metrics',
'reference/api/legacy/unleash/client/register',
],
'System API': [
'reference/api/legacy/unleash/internal/prometheus',
'reference/api/legacy/unleash/internal/health',
],
},
],
},
],
},
{
type: 'category',
label: 'Application SDKs',
link: { type: 'doc', id: 'reference/sdks/index' },
items: [
{
type: 'category',
label: 'Server-side SDKs',
items: [
{
type: 'autogenerated',
dirName: 'generated/sdks/server-side',
},
],
},
{
type: 'category',
label: 'Client-side SDKs',
items: [
{
type: 'autogenerated',
dirName: 'generated/sdks/client-side',
},
],
},
{
type: 'link',
label: 'Community SDKs',
href: '/reference/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: '/reference/deploy',
},
label: 'Deploy and manage Unleash',
items: [
'reference/deploy/getting-started',
'reference/deploy/configuring-unleash',
'reference/deploy/database-setup',
'reference/deploy/database-backup',
'reference/deploy/email-service',
'reference/deploy/google-auth-hook',
'reference/deploy/import-export',
'reference/deploy/environment-import-export',
'reference/deploy/migration-guide',
'reference/deploy/securing-unleash',
],
},
{
type: 'category',
label: 'Integrations',
link: {
type: 'doc',
id: 'reference/integrations/integrations',
},
items: [
{
'Jira Server': [
'reference/integrations/jira-server-plugin-installation',
'reference/integrations/jira-server-plugin-usage',
],
'Jira Cloud': [
'reference/integrations/jira-cloud-plugin-installation',
'reference/integrations/jira-cloud-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: [
'reference/activation-strategies',
'reference/api-tokens-and-client-keys',
'reference/archived-toggles',
'reference/event-log',
'reference/impression-data',
'reference/custom-activation-strategies',
'reference/environments',
'reference/feature-toggles',
'reference/feature-toggle-types',
'reference/feature-toggle-variants',
'reference/front-end-api',
'reference/login-history',
'reference/maintenance-mode',
'reference/network-view',
'reference/notifications',
'reference/playground',
'reference/public-signup',
'reference/projects',
'reference/project-collaboration-mode',
'reference/rbac',
'reference/segments',
'reference/service-accounts',
'reference/sso',
'reference/stickiness',
'reference/strategy-constraints',
'reference/tags',
'reference/technical-debt',
'reference/unleash-context',
'reference/change-requests',
],
},
'generated/unleash-edge',
'generated/unleash-proxy',
],
},
{
label: 'Developer contribution docs',
type: 'category',
collapsed: true,
link: {
type: 'generated-index',
title: 'Developer Guide',
description: 'Learn how to contribute to unleash.',
slug: '/developer-guide',
},
items: [
'contributing/developer-guide',
'contributing/frontend/overview',
'contributing/backend/overview',
{
type: 'category',
label: 'Architectural Decision Records',
items: [
{
type: 'autogenerated',
dirName: 'contributing/ADRs', // '.' means the current docs folder
},
],
},
],
},
],
};