mirror of
https://github.com/Unleash/unleash.git
synced 2024-10-18 20:09:08 +02:00
d5fbd0b743
## What This (admittedly massive) PR updates the "physical" documentation structure and fixes url inconsistencies and SEO problems reported by marketing. The main points are: - remove or move directories : advanced, user_guide, deploy, api - move the files contained within to the appropriate one of topics, how-to, tutorials, or reference - update internal doc links and product links to the content - create client-side redirects for all the urls that have changed. A number of the files have been renamed in small ways to better match their url and to make them easier to find. Additionally, the top-level api directory has been moved to /reference/api/legacy/unleash (see the discussion points section for more on this). ## Why When moving our doc structure to diataxis a while back, we left the "physical' files lying where they were, because it didn't matter much to the new structure. However, that did introduce some inconsistencies with where you place docs and how we organize them. There's also the discrepancies in whether urls us underscores or hyphens (which isn't necessarily the same as their file name), which has been annoying me for a while, but now has also been raised by marketing as an issue in terms of SEO. ## Discussion points The old, hand-written API docs have been moved from /api to /reference/api/legacy/unleash. There _is_ a /reference/api/unleash directory, but this is being populated by the OpenAPI plugin, and mixing those could only cause trouble. However, I'm unsure about putting /legacy/ in the title, because the API isn't legacy, the docs are. Maybe we could use another path? Like /old-docs/ or something? I'd appreciate some input on this.
346 lines
15 KiB
JavaScript
346 lines
15 KiB
JavaScript
/**
|
|
* 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/proxy-hosting',
|
|
],
|
|
},
|
|
{
|
|
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-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',
|
|
],
|
|
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-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',
|
|
link: {
|
|
type: 'doc',
|
|
id: 'reference/api/legacy/unleash/index',
|
|
},
|
|
label: 'APIs',
|
|
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',
|
|
],
|
|
},
|
|
{
|
|
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: 'Application SDKs',
|
|
link: { type: 'doc', id: 'reference/sdks/index' },
|
|
items: [
|
|
{
|
|
type: 'category',
|
|
label: 'Server-side SDKs',
|
|
items: [
|
|
'reference/sdks/go',
|
|
'reference/sdks/java',
|
|
'reference/sdks/node',
|
|
'reference/sdks/php',
|
|
'reference/sdks/python',
|
|
'reference/sdks/ruby',
|
|
{
|
|
type: 'link',
|
|
href: 'https://github.com/unleash/unleash-client-rust',
|
|
label: 'Rust SDK',
|
|
},
|
|
'reference/sdks/dotnet',
|
|
],
|
|
},
|
|
{
|
|
type: 'category',
|
|
label: 'Client-side SDKs',
|
|
items: [
|
|
'reference/sdks/android-proxy',
|
|
'reference/sdks/ios-proxy',
|
|
'reference/sdks/javascript-browser',
|
|
'reference/sdks/react',
|
|
'reference/sdks/svelte',
|
|
'reference/sdks/vue',
|
|
],
|
|
},
|
|
{
|
|
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/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',
|
|
],
|
|
},
|
|
,
|
|
],
|
|
},
|
|
{
|
|
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/playground',
|
|
'reference/public-signup',
|
|
'reference/projects',
|
|
'reference/rbac',
|
|
'reference/segments',
|
|
'reference/sso',
|
|
'reference/stickiness',
|
|
'reference/strategy-constraints',
|
|
'reference/tags',
|
|
'reference/technical-debt',
|
|
'reference/unleash-context',
|
|
'reference/unleash-proxy',
|
|
],
|
|
},
|
|
],
|
|
},
|
|
],
|
|
};
|