Merge pull request #27803 from aramissennyeydd/sennyeya/adjust-docs-org
chore: organize sidebar a bit
This commit is contained in:
Patrik Oldsberg
+240
-225
@@ -49,6 +49,97 @@ module.exports = {
|
||||
'getting-started/keeping-backstage-updated',
|
||||
],
|
||||
'Core Features': [
|
||||
{
|
||||
type: 'category',
|
||||
label: 'Auth and Identity',
|
||||
items: [
|
||||
'auth/index',
|
||||
{
|
||||
type: 'category',
|
||||
label: 'Included providers',
|
||||
items: [
|
||||
'auth/auth0/provider',
|
||||
'auth/atlassian/provider',
|
||||
'auth/aws-alb/provider',
|
||||
'auth/microsoft/provider',
|
||||
'auth/microsoft/easy-auth',
|
||||
'auth/bitbucket/provider',
|
||||
'auth/bitbucketServer/provider',
|
||||
'auth/cloudflare/provider',
|
||||
'auth/github/provider',
|
||||
'auth/gitlab/provider',
|
||||
'auth/google/provider',
|
||||
'auth/google/gcp-iap-auth',
|
||||
'auth/guest/provider',
|
||||
'auth/okta/provider',
|
||||
'auth/oauth2-proxy/provider',
|
||||
'auth/onelogin/provider',
|
||||
'auth/vmware-cloud/provider',
|
||||
],
|
||||
},
|
||||
'auth/identity-resolver',
|
||||
'auth/oauth',
|
||||
'auth/oidc',
|
||||
'auth/add-auth-provider',
|
||||
'auth/service-to-service-auth',
|
||||
'auth/autologout',
|
||||
'auth/troubleshooting',
|
||||
],
|
||||
},
|
||||
{
|
||||
type: 'category',
|
||||
label: 'Kubernetes',
|
||||
items: [
|
||||
'features/kubernetes/overview',
|
||||
'features/kubernetes/installation',
|
||||
'features/kubernetes/configuration',
|
||||
'features/kubernetes/authentication',
|
||||
'features/kubernetes/authentication-strategies',
|
||||
'features/kubernetes/troubleshooting',
|
||||
'features/kubernetes/proxy',
|
||||
],
|
||||
},
|
||||
{
|
||||
type: 'category',
|
||||
label: 'Notifications',
|
||||
items: ['notifications/index'],
|
||||
},
|
||||
{
|
||||
type: 'category',
|
||||
label: 'Permissions',
|
||||
items: [
|
||||
'permissions/overview',
|
||||
'permissions/concepts',
|
||||
'permissions/getting-started',
|
||||
'permissions/writing-a-policy',
|
||||
'permissions/frontend-integration',
|
||||
'permissions/custom-rules',
|
||||
{
|
||||
type: 'category',
|
||||
label: 'Tutorial: using Permissions in your plugin',
|
||||
items: [
|
||||
'permissions/plugin-authors/01-setup',
|
||||
'permissions/plugin-authors/02-adding-a-basic-permission-check',
|
||||
'permissions/plugin-authors/03-adding-a-resource-permission-check',
|
||||
'permissions/plugin-authors/04-authorizing-access-to-paginated-data',
|
||||
'permissions/plugin-authors/05-frontend-authorization',
|
||||
],
|
||||
},
|
||||
],
|
||||
},
|
||||
{
|
||||
type: 'category',
|
||||
label: 'Search',
|
||||
items: [
|
||||
'features/search/search-overview',
|
||||
'features/search/getting-started',
|
||||
'features/search/concepts',
|
||||
'features/search/architecture',
|
||||
'features/search/search-engines',
|
||||
'features/search/collators',
|
||||
'features/search/how-to-guides',
|
||||
],
|
||||
},
|
||||
{
|
||||
type: 'category',
|
||||
label: 'Software Catalog',
|
||||
@@ -70,19 +161,6 @@ module.exports = {
|
||||
'features/software-catalog/faq',
|
||||
],
|
||||
},
|
||||
{
|
||||
type: 'category',
|
||||
label: 'Kubernetes',
|
||||
items: [
|
||||
'features/kubernetes/overview',
|
||||
'features/kubernetes/installation',
|
||||
'features/kubernetes/configuration',
|
||||
'features/kubernetes/authentication',
|
||||
'features/kubernetes/authentication-strategies',
|
||||
'features/kubernetes/troubleshooting',
|
||||
'features/kubernetes/proxy',
|
||||
],
|
||||
},
|
||||
{
|
||||
type: 'category',
|
||||
label: 'Software Templates',
|
||||
@@ -104,19 +182,6 @@ module.exports = {
|
||||
'features/software-templates/experimental',
|
||||
],
|
||||
},
|
||||
{
|
||||
type: 'category',
|
||||
label: 'Backstage Search',
|
||||
items: [
|
||||
'features/search/search-overview',
|
||||
'features/search/getting-started',
|
||||
'features/search/concepts',
|
||||
'features/search/architecture',
|
||||
'features/search/search-engines',
|
||||
'features/search/collators',
|
||||
'features/search/how-to-guides',
|
||||
],
|
||||
},
|
||||
{
|
||||
type: 'category',
|
||||
label: 'TechDocs',
|
||||
@@ -285,189 +350,142 @@ module.exports = {
|
||||
'conf/writing',
|
||||
'conf/defining',
|
||||
],
|
||||
Notifications: ['notifications/index'],
|
||||
'Auth and identity': [
|
||||
'auth/index',
|
||||
Framework: [
|
||||
{
|
||||
type: 'category',
|
||||
label: 'Included providers',
|
||||
label: 'Backend System',
|
||||
items: [
|
||||
'auth/auth0/provider',
|
||||
'auth/atlassian/provider',
|
||||
'auth/aws-alb/provider',
|
||||
'auth/microsoft/provider',
|
||||
'auth/microsoft/easy-auth',
|
||||
'auth/bitbucket/provider',
|
||||
'auth/bitbucketServer/provider',
|
||||
'auth/cloudflare/provider',
|
||||
'auth/github/provider',
|
||||
'auth/gitlab/provider',
|
||||
'auth/google/provider',
|
||||
'auth/google/gcp-iap-auth',
|
||||
'auth/guest/provider',
|
||||
'auth/okta/provider',
|
||||
'auth/oauth2-proxy/provider',
|
||||
'auth/onelogin/provider',
|
||||
'auth/vmware-cloud/provider',
|
||||
'backend-system/index',
|
||||
{
|
||||
type: 'category',
|
||||
label: 'Architecture',
|
||||
items: [
|
||||
'backend-system/architecture/index',
|
||||
'backend-system/architecture/services',
|
||||
'backend-system/architecture/plugins',
|
||||
'backend-system/architecture/extension-points',
|
||||
'backend-system/architecture/modules',
|
||||
'backend-system/architecture/feature-loaders',
|
||||
'backend-system/architecture/naming-patterns',
|
||||
],
|
||||
},
|
||||
{
|
||||
type: 'category',
|
||||
label: 'Building Backends',
|
||||
items: [
|
||||
'backend-system/building-backends/index',
|
||||
'backend-system/building-backends/migrating',
|
||||
],
|
||||
},
|
||||
{
|
||||
type: 'category',
|
||||
label: 'Building Plugins & Modules',
|
||||
items: [
|
||||
'backend-system/building-plugins-and-modules/index',
|
||||
'backend-system/building-plugins-and-modules/testing',
|
||||
'backend-system/building-plugins-and-modules/migrating',
|
||||
],
|
||||
},
|
||||
{
|
||||
type: 'category',
|
||||
label: 'Core Services',
|
||||
items: [
|
||||
'backend-system/core-services/index',
|
||||
'backend-system/core-services/auth',
|
||||
'backend-system/core-services/cache',
|
||||
'backend-system/core-services/database',
|
||||
'backend-system/core-services/discovery',
|
||||
'backend-system/core-services/http-auth',
|
||||
'backend-system/core-services/http-router',
|
||||
'backend-system/core-services/identity',
|
||||
'backend-system/core-services/lifecycle',
|
||||
'backend-system/core-services/logger',
|
||||
'backend-system/core-services/permissions',
|
||||
'backend-system/core-services/plugin-metadata',
|
||||
'backend-system/core-services/root-config',
|
||||
'backend-system/core-services/root-health',
|
||||
'backend-system/core-services/root-http-router',
|
||||
'backend-system/core-services/root-lifecycle',
|
||||
'backend-system/core-services/root-logger',
|
||||
'backend-system/core-services/scheduler',
|
||||
'backend-system/core-services/token-manager',
|
||||
'backend-system/core-services/url-reader',
|
||||
'backend-system/core-services/user-info',
|
||||
],
|
||||
},
|
||||
],
|
||||
},
|
||||
'auth/identity-resolver',
|
||||
'auth/oauth',
|
||||
'auth/oidc',
|
||||
'auth/add-auth-provider',
|
||||
'auth/service-to-service-auth',
|
||||
'auth/autologout',
|
||||
'auth/troubleshooting',
|
||||
],
|
||||
Permissions: [
|
||||
'permissions/overview',
|
||||
'permissions/concepts',
|
||||
'permissions/getting-started',
|
||||
'permissions/writing-a-policy',
|
||||
'permissions/frontend-integration',
|
||||
'permissions/custom-rules',
|
||||
{
|
||||
type: 'category',
|
||||
label: 'Tutorial: using Permissions in your plugin',
|
||||
label: 'New Frontend System',
|
||||
items: [
|
||||
'permissions/plugin-authors/01-setup',
|
||||
'permissions/plugin-authors/02-adding-a-basic-permission-check',
|
||||
'permissions/plugin-authors/03-adding-a-resource-permission-check',
|
||||
'permissions/plugin-authors/04-authorizing-access-to-paginated-data',
|
||||
'permissions/plugin-authors/05-frontend-authorization',
|
||||
'frontend-system/index',
|
||||
{
|
||||
type: 'category',
|
||||
label: 'Architecture',
|
||||
items: [
|
||||
'frontend-system/architecture/index',
|
||||
'frontend-system/architecture/app',
|
||||
'frontend-system/architecture/plugins',
|
||||
'frontend-system/architecture/extensions',
|
||||
'frontend-system/architecture/extension-blueprints',
|
||||
'frontend-system/architecture/extension-overrides',
|
||||
'frontend-system/architecture/references',
|
||||
'frontend-system/architecture/utility-apis',
|
||||
'frontend-system/architecture/routes',
|
||||
'frontend-system/architecture/naming-patterns',
|
||||
'frontend-system/architecture/migrations',
|
||||
],
|
||||
},
|
||||
{
|
||||
type: 'category',
|
||||
label: 'Building Plugins',
|
||||
items: [
|
||||
'frontend-system/building-plugins/index',
|
||||
'frontend-system/building-plugins/testing',
|
||||
'frontend-system/building-plugins/common-extension-blueprints',
|
||||
'frontend-system/building-plugins/built-in-data-refs',
|
||||
'frontend-system/building-plugins/migrating',
|
||||
],
|
||||
},
|
||||
{
|
||||
type: 'category',
|
||||
label: 'Building Apps',
|
||||
items: [
|
||||
'frontend-system/building-apps/index',
|
||||
'frontend-system/building-apps/configuring-extensions',
|
||||
'frontend-system/building-apps/built-in-extensions',
|
||||
'frontend-system/building-apps/plugin-conversion',
|
||||
'frontend-system/building-apps/migrating',
|
||||
],
|
||||
},
|
||||
{
|
||||
type: 'category',
|
||||
label: 'Utility APIs',
|
||||
items: [
|
||||
'frontend-system/utility-apis/index',
|
||||
'frontend-system/utility-apis/creating',
|
||||
'frontend-system/utility-apis/consuming',
|
||||
'frontend-system/utility-apis/configuring',
|
||||
],
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
Tooling: [
|
||||
{
|
||||
type: 'category',
|
||||
label: 'Backstage CLI',
|
||||
items: [
|
||||
'Backstage CLI': [
|
||||
'tooling/cli/overview',
|
||||
'tooling/cli/build-system',
|
||||
'tooling/cli/commands',
|
||||
],
|
||||
},
|
||||
{
|
||||
type: 'category',
|
||||
label: 'Local Development',
|
||||
items: [
|
||||
'tooling/local-dev/linking-local-packages',
|
||||
'tooling/local-dev/debugging',
|
||||
'tooling/local-dev/profiling',
|
||||
],
|
||||
},
|
||||
'tooling/package-metadata',
|
||||
],
|
||||
'New Backend System': [
|
||||
'backend-system/index',
|
||||
{
|
||||
type: 'category',
|
||||
label: 'Architecture',
|
||||
items: [
|
||||
'backend-system/architecture/index',
|
||||
'backend-system/architecture/services',
|
||||
'backend-system/architecture/plugins',
|
||||
'backend-system/architecture/extension-points',
|
||||
'backend-system/architecture/modules',
|
||||
'backend-system/architecture/feature-loaders',
|
||||
'backend-system/architecture/naming-patterns',
|
||||
],
|
||||
},
|
||||
{
|
||||
type: 'category',
|
||||
label: 'Building Backends',
|
||||
items: [
|
||||
'backend-system/building-backends/index',
|
||||
'backend-system/building-backends/migrating',
|
||||
],
|
||||
},
|
||||
{
|
||||
type: 'category',
|
||||
label: 'Building Plugins & Modules',
|
||||
items: [
|
||||
'backend-system/building-plugins-and-modules/index',
|
||||
'backend-system/building-plugins-and-modules/testing',
|
||||
'backend-system/building-plugins-and-modules/migrating',
|
||||
],
|
||||
},
|
||||
{
|
||||
type: 'category',
|
||||
label: 'Core Services',
|
||||
items: [
|
||||
'backend-system/core-services/index',
|
||||
'backend-system/core-services/auth',
|
||||
'backend-system/core-services/cache',
|
||||
'backend-system/core-services/database',
|
||||
'backend-system/core-services/discovery',
|
||||
'backend-system/core-services/http-auth',
|
||||
'backend-system/core-services/http-router',
|
||||
'backend-system/core-services/identity',
|
||||
'backend-system/core-services/lifecycle',
|
||||
'backend-system/core-services/logger',
|
||||
'backend-system/core-services/permissions',
|
||||
'backend-system/core-services/plugin-metadata',
|
||||
'backend-system/core-services/root-config',
|
||||
'backend-system/core-services/root-health',
|
||||
'backend-system/core-services/root-http-router',
|
||||
'backend-system/core-services/root-lifecycle',
|
||||
'backend-system/core-services/root-logger',
|
||||
'backend-system/core-services/scheduler',
|
||||
'backend-system/core-services/token-manager',
|
||||
'backend-system/core-services/url-reader',
|
||||
'backend-system/core-services/user-info',
|
||||
],
|
||||
},
|
||||
],
|
||||
'New Frontend System': [
|
||||
'frontend-system/index',
|
||||
{
|
||||
type: 'category',
|
||||
label: 'Architecture',
|
||||
items: [
|
||||
'frontend-system/architecture/index',
|
||||
'frontend-system/architecture/app',
|
||||
'frontend-system/architecture/plugins',
|
||||
'frontend-system/architecture/extensions',
|
||||
'frontend-system/architecture/extension-blueprints',
|
||||
'frontend-system/architecture/extension-overrides',
|
||||
'frontend-system/architecture/references',
|
||||
'frontend-system/architecture/utility-apis',
|
||||
'frontend-system/architecture/routes',
|
||||
'frontend-system/architecture/naming-patterns',
|
||||
'frontend-system/architecture/migrations',
|
||||
],
|
||||
},
|
||||
{
|
||||
type: 'category',
|
||||
label: 'Building Plugins',
|
||||
items: [
|
||||
'frontend-system/building-plugins/index',
|
||||
'frontend-system/building-plugins/testing',
|
||||
'frontend-system/building-plugins/common-extension-blueprints',
|
||||
'frontend-system/building-plugins/built-in-data-refs',
|
||||
'frontend-system/building-plugins/migrating',
|
||||
],
|
||||
},
|
||||
{
|
||||
type: 'category',
|
||||
label: 'Building Apps',
|
||||
items: [
|
||||
'frontend-system/building-apps/index',
|
||||
'frontend-system/building-apps/configuring-extensions',
|
||||
'frontend-system/building-apps/built-in-extensions',
|
||||
'frontend-system/building-apps/plugin-conversion',
|
||||
'frontend-system/building-apps/migrating',
|
||||
],
|
||||
},
|
||||
{
|
||||
type: 'category',
|
||||
label: 'Utility APIs',
|
||||
items: [
|
||||
'frontend-system/utility-apis/index',
|
||||
'frontend-system/utility-apis/creating',
|
||||
'frontend-system/utility-apis/consuming',
|
||||
'frontend-system/utility-apis/configuring',
|
||||
{
|
||||
type: 'category',
|
||||
label: 'Local Development',
|
||||
items: [
|
||||
'tooling/local-dev/linking-local-packages',
|
||||
'tooling/local-dev/debugging',
|
||||
'tooling/local-dev/profiling',
|
||||
],
|
||||
},
|
||||
'tooling/package-metadata',
|
||||
],
|
||||
},
|
||||
],
|
||||
@@ -477,19 +495,6 @@ module.exports = {
|
||||
'dls/contributing-to-storybook',
|
||||
'dls/figma',
|
||||
],
|
||||
'API Reference': [
|
||||
{
|
||||
type: 'category',
|
||||
label: 'Guides',
|
||||
items: ['api/utility-apis'],
|
||||
},
|
||||
{
|
||||
type: 'category',
|
||||
label: 'API Reference',
|
||||
items: ['reference/index'],
|
||||
},
|
||||
'api/deprecations',
|
||||
],
|
||||
Tutorials: [
|
||||
'tutorials/quickstart-app-plugin',
|
||||
'tutorials/react-router-stable-migration',
|
||||
@@ -505,22 +510,7 @@ module.exports = {
|
||||
'tutorials/enable-public-entry',
|
||||
'tutorials/setup-opentelemetry',
|
||||
],
|
||||
'Architecture Decision Records (ADRs)': [
|
||||
'architecture-decisions/adrs-overview',
|
||||
'architecture-decisions/adrs-adr001',
|
||||
'architecture-decisions/adrs-adr002',
|
||||
'architecture-decisions/adrs-adr003',
|
||||
'architecture-decisions/adrs-adr004',
|
||||
'architecture-decisions/adrs-adr005',
|
||||
'architecture-decisions/adrs-adr006',
|
||||
'architecture-decisions/adrs-adr007',
|
||||
'architecture-decisions/adrs-adr008',
|
||||
'architecture-decisions/adrs-adr009',
|
||||
'architecture-decisions/adrs-adr010',
|
||||
'architecture-decisions/adrs-adr011',
|
||||
'architecture-decisions/adrs-adr012',
|
||||
'architecture-decisions/adrs-adr013',
|
||||
],
|
||||
|
||||
FAQ: ['faq/index', 'faq/product', 'faq/technical'],
|
||||
Accessibility: ['accessibility/index'],
|
||||
Contribute: [
|
||||
@@ -528,7 +518,32 @@ module.exports = {
|
||||
'contribute/getting-involved',
|
||||
'contribute/project-structure',
|
||||
],
|
||||
References: ['references/glossary'],
|
||||
References: [
|
||||
{
|
||||
type: 'category',
|
||||
label: 'Architecture Decision Records (ADRs)',
|
||||
items: [
|
||||
'architecture-decisions/adrs-overview',
|
||||
'architecture-decisions/adrs-adr001',
|
||||
'architecture-decisions/adrs-adr002',
|
||||
'architecture-decisions/adrs-adr003',
|
||||
'architecture-decisions/adrs-adr004',
|
||||
'architecture-decisions/adrs-adr005',
|
||||
'architecture-decisions/adrs-adr006',
|
||||
'architecture-decisions/adrs-adr007',
|
||||
'architecture-decisions/adrs-adr008',
|
||||
'architecture-decisions/adrs-adr009',
|
||||
'architecture-decisions/adrs-adr010',
|
||||
'architecture-decisions/adrs-adr011',
|
||||
'architecture-decisions/adrs-adr012',
|
||||
'architecture-decisions/adrs-adr013',
|
||||
],
|
||||
},
|
||||
'api/deprecations',
|
||||
'references/glossary',
|
||||
'api/utility-apis',
|
||||
'reference/index',
|
||||
],
|
||||
},
|
||||
releases: {
|
||||
'Release Notes': releases.map(release => `releases/${release}`),
|
||||
|
||||
Reference in New Issue
Block a user