kubevela.github.io/sidebars.js

218 lines
7.0 KiB
JavaScript

const { Component } = require('react');
module.exports = {
docs: [
'getting-started/introduction',
'install',
'quick-start',
{
type: 'category',
label: 'Basics',
collapsed: true,
items: ['getting-started/core-concept', 'getting-started/architecture'],
},
{
type: 'category',
label: 'User Guide',
collapsed: false,
items: [
'tutorials/webservice',
'tutorials/helm',
'tutorials/k8s-object',
'tutorials/consume-cloud-services',
{
type: 'category',
label: 'Deploy with more workload type',
collapsed: true,
items: [
'end-user/components/cue/task',
'end-user/components/kustomize',
'end-user/components/ref-objects',
'end-user/components/more',
],
},
'case-studies/multi-cluster',
'tutorials/jenkins',
'tutorials/trigger',
'case-studies/gitops',
{
type: 'category',
label: 'How-to Guides',
collapsed: true,
items: [
{
'Cloud Resources': [
'end-user/components/cloud-services/provision-and-consume-cloud-services',
'end-user/components/cloud-services/provision-and-initiate-database',
'end-user/components/cloud-services/secure-your-database-connection',
'end-user/components/cloud-services/provision-an-RDS-instance-with-more-than-one-database',
],
},
{
'Deploy applications': [
'how-to/dashboard/application/create-application',
'how-to/dashboard/application/bind-new-environment',
'tutorials/workflows',
'how-to/dashboard/application/deploy-application',
'how-to/dashboard/application/get-application-instance',
'tutorials/scaler',
'how-to/dashboard/application/get-application-log',
'how-to/dashboard/application/get-application-endpoint',
'how-to/dashboard/application/view-application-resource',
'how-to/dashboard/application/get-application-revision',
'how-to/dashboard/application/recycle-environment',
'how-to/dashboard/application/delete-application',
],
},
{
'Day-2 Operations': [
'end-user/traits/rollout',
'end-user/traits/ingress',
'end-user/traits/service-binding',
'end-user/traits/sidecar',
'end-user/policies/health',
'end-user/workflow/webhook-notification',
'end-user/service-account-integration',
'how-to/dashboard/trigger/overview',
'end-user/traits/more',
],
},
{
'Manage integration configs': [
'how-to/dashboard/config/dex-connectors',
'how-to/dashboard/config/helm-repo',
],
},
{
'Advanced Features': [
'end-user/workflow/component-dependency-parameter',
'end-user/version-control',
'end-user/policies/apply-once',
'end-user/policies/gc',
],
},
],
},
],
},
{
type: 'category',
label: 'Operator Manual',
items: [
'tutorials/sso',
'how-to/dashboard/user/user',
'how-to/dashboard/user/rbac',
'how-to/dashboard/user/project',
{
'Manage resource': [
'platform-engineers/system-operation/managing-clusters',
'how-to/dashboard/target/overview',
],
},
'how-to/addon',
{
'Install or upgrade': [
'platform-engineers/system-operation/bootstrap-parameters',
'platform-engineers/advanced-install',
'platform-engineers/system-operation/offline-installation',
],
},
'platform-engineers/system-operation/observability',
'platform-engineers/system-operation/performance-finetuning',
{
type: 'category',
label: 'Extension',
collapsed: true,
items: [
{
type: 'category',
label: 'Learning OAM',
collapsed: false,
items: [
'platform-engineers/oam/oam-model',
'platform-engineers/oam/x-definition',
],
},
{
'Learning CUE': [
'platform-engineers/cue/basic',
'platform-engineers/cue/definition-edit',
'platform-engineers/cue/advanced',
],
},
{
Addons: ['platform-engineers/addon/intro'],
},
'platform-engineers/components/custom-component',
{
'Cloud Resources': [
'platform-engineers/addon/terraform',
'platform-engineers/components/component-terraform',
],
},
{
type: 'category',
label: 'Traits System',
items: [
'platform-engineers/traits/customize-trait',
'platform-engineers/traits/patch-trait',
'platform-engineers/traits/status',
'platform-engineers/traits/advanced',
],
},
{
'Workflow System': [
'platform-engineers/workflow/workflow',
'platform-engineers/workflow/cue-actions',
'platform-engineers/workflow/working-mechanism',
],
},
'platform-engineers/system-operation/velaql',
'platform-engineers/debug/dry-run',
'platform-engineers/x-def-version',
],
},
],
},
'contributor/overview',
{
type: 'category',
label: 'References',
items: [
'cli/vela',
{
type: 'category',
label: 'Built-in Addons',
items: [
'reference/addons/overview',
'reference/addons/velaux',
'reference/addons/terraform',
'reference/addons/ai',
],
},
'end-user/components/cloud-services/cloud-resources-list',
'end-user/components/references',
'end-user/traits/references',
'end-user/policies/references',
'end-user/workflow/built-in-workflow-defs',
'reference/ui-schema',
'reference/user-improvement-plan',
{
label: 'VelaUX API Doc',
type: 'link',
href: 'https://kubevela.stoplight.io/docs/kubevela/b3A6NDI5NzQxMzM-detail-definition',
},
],
},
{
type: 'category',
label: 'Roadmap',
items: ['roadmap/README'],
},
{
type: 'doc',
id: 'developers/references/devex/faq',
},
],
};