kubevela
/
kubevela.github.io
mirror of https://github.com/kubevela/kubevela.github.io.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Docs: add howto doc 

Signed-off-by: barnettZQG <barnett.zqg@gmail.com>
This commit is contained in:
barnettZQG 2022-01-10 12:05:35 +08:00
parent 9d9f5c39f2
commit 57058253d1
21 changed files with 189 additions and 55 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
docs/how-to/dashboard/addon/overview.md Normal file
View File

@ -0,0 +1,3 @@
---
title: Overview
---

3
docs/how-to/dashboard/application/bind-new-environment.md Normal file
View File

@ -0,0 +1,3 @@
---
title: Bind new environment
---

4
docs/how-to/dashboard/application/create-application.md Normal file
View File

@ -0,0 +1,4 @@
---
title: Create an application
description: create an application by kubevela dashboard
---

4
docs/how-to/dashboard/application/delete-application.md Normal file
View File

@ -0,0 +1,4 @@
---
title: Delete an application
description: delete an application by kubevela dashboard
---

4
docs/how-to/dashboard/application/deploy-application.md Normal file
View File

@ -0,0 +1,4 @@
---
title: Deploy an application to environment
description: deploy an application to environment by kubevela dashboard
---

4
docs/how-to/dashboard/application/get-application-endpoint.md Normal file
View File

@ -0,0 +1,4 @@
---
title: View an application endpoints
description: View an application endpoints by kubevela dashboard
---

4
docs/how-to/dashboard/application/get-application-instance.md Normal file
View File

@ -0,0 +1,4 @@
---
title: View an application instances
description: View an application instances by kubevela dashboard
---

4
docs/how-to/dashboard/application/get-application-log.md Normal file
View File

@ -0,0 +1,4 @@
---
title: View an application log
description: View an application log by kubevela dashboard
---

4
docs/how-to/dashboard/application/get-application-revision.md Normal file
View File

@ -0,0 +1,4 @@
---
title: View an application revision
description: View an application revision by kubevela dashboard
---

21
docs/how-to/dashboard/application/overview.md Normal file
View File

@ -0,0 +1,21 @@
---
title: Overview
---
### [Create An Application](./create-application)
### [Deploy An Application](./deploy-application)
### [View an application instances](./get-application-instance)
### [View an application log](./get-application-log)
### [View an application endpoint](./get-application-endpoint)
### [View an application revision](./get-application-revision)
### [Bind new environment](./bind-new-environment)
### [Recycle an environment](./recycle-environment)
### [Delete An Application](./delete-application)

3
docs/how-to/dashboard/application/recycle-environment.md Normal file
View File

@ -0,0 +1,3 @@
---
title: Recycle an environment
---

5
docs/how-to/dashboard/cluster/connect-cluster.md Normal file
View File

@ -0,0 +1,5 @@
---
title: Connect a kubernetes cluster
---
We support connect and detach the kubernetes cluster.

5
docs/how-to/dashboard/cluster/detach-cluster.md Normal file
View File

@ -0,0 +1,5 @@
---
title: Detach a kubernetes cluster
---
We support connect and detach the kubernetes cluster.

5
docs/how-to/dashboard/cluster/edit-cluster.md Normal file
View File

@ -0,0 +1,5 @@
---
title: Edit kubernetes cluster
---
We support connect and detach the kubernetes cluster.

3
docs/how-to/dashboard/cluster/overview.md Normal file
View File

@ -0,0 +1,3 @@
---
title: Overview
---

5
docs/how-to/dashboard/cluster/set-cluster-dashboard.md Normal file
View File

@ -0,0 +1,5 @@
---
title: Set cluster dashboard
---
We support connect and detach the kubernetes cluster.

3
docs/how-to/dashboard/environment/overview.md Normal file
View File

@ -0,0 +1,3 @@
---
title: Overview
---

3
docs/how-to/dashboard/target/overview.md Normal file
View File

@ -0,0 +1,3 @@
---
title: Overview
---

3
docs/how-to/dashboard/trait/overview.md Normal file
View File

@ -0,0 +1,3 @@
---
title: Overview
---

3
docs/how-to/dashboard/workflow/overview.md Normal file
View File

@ -0,0 +1,3 @@
---
title: Overview
---

151
sidebars.js
View File

@ -21,7 +21,7 @@ module.exports = {
},
{
type: "category",
label: "Continuous Delivery",
label: "Tutorials",
collapsed: false,
items: [
"deliver-app/webservice",
@ -45,75 +45,96 @@ module.exports = {
},
{
type: "category",
label: "Vela CLI Manuals",
label: "How-to Guides",
collapsed: true,
items: [
"end-user/quick-start-cli",
{
"Deploying Components": [
"end-user/components/helm",
"end-user/components/kustomize",
Dashboard: [
{
"Cloud Services": [
{
Terraform: [
"end-user/components/cloud-services/terraform/alibaba-ack",
"end-user/components/cloud-services/terraform/alibaba-eip",
"end-user/components/cloud-services/terraform/alibaba-rds",
"end-user/components/cloud-services/terraform/alibaba-oss",
"end-user/components/cloud-services/terraform/alibaba-redis",
"end-user/components/cloud-services/terraform/alibaba-vpc",
"end-user/components/cloud-services/terraform/azure-database-mariadb",
"end-user/components/cloud-services/terraform/azure-storage-account",
"end-user/components/cloud-services/terraform/aws-s3",
],
},
"Manage application": [
"how-to/dashboard/application/overview",
"how-to/dashboard/application/create-application",
"how-to/dashboard/application/deploy-application",
"how-to/dashboard/application/get-application-instance",
"how-to/dashboard/application/get-application-log",
"how-to/dashboard/application/get-application-endpoint",
"how-to/dashboard/application/get-application-revision",
"how-to/dashboard/application/bind-new-environment",
"how-to/dashboard/application/recycle-environment",
"how-to/dashboard/application/delete-application",
],
},
{
"Manage workflow": ["how-to/dashboard/workflow/overview"],
},
{
"Manage trait": ["how-to/dashboard/trait/overview"],
},
{
"Manage environment": ["how-to/dashboard/environment/overview"],
},
{
"Manage target": ["how-to/dashboard/target/overview"],
},
{
"Manage cluster": [
"how-to/dashboard/cluster/overview",
"how-to/dashboard/cluster/connect-cluster",
"how-to/dashboard/cluster/detach-cluster",
"how-to/dashboard/cluster/set-cluster-dashboard",
"how-to/dashboard/cluster/edit-cluster",
],
},
{
"Manage addon": [],
},
],
CLI: [
"end-user/quick-start-cli",
{
"Deploying Components": [
"end-user/components/helm",
"end-user/components/kustomize",
"end-user/components/cloud-services/provider-and-consume-cloud-services",
"end-user/components/cue/raw",
"end-user/components/more",
],
},
{
CUE: [
"end-user/components/cue/webservice",
"end-user/components/cue/worker",
"end-user/components/cue/task",
"Attaching Traits": [
"end-user/traits/ingress",
"end-user/traits/rollout",
"end-user/traits/autoscaler",
"end-user/traits/annotations-and-labels",
"end-user/traits/service-binding",
"end-user/traits/sidecar",
"end-user/traits/kustomize-patch",
"end-user/traits/more",
],
},
"end-user/components/cue/raw",
"end-user/components/more",
{
"Defining Policies": [
"end-user/policies/envbinding",
"end-user/policies/health",
],
},
{
"Designing Workflow": [
"end-user/workflow/built-in-workflow-defs",
"end-user/workflow/webhook-notification",
"end-user/workflow/component-dependency-parameter",
],
},
"case-studies/multi-cluster",
"end-user/version-control",
],
},
{
"Attaching Traits": [
"end-user/traits/ingress",
"end-user/traits/rollout",
"end-user/traits/autoscaler",
"end-user/traits/annotations-and-labels",
"end-user/traits/service-binding",
"end-user/traits/sidecar",
"end-user/traits/kustomize-patch",
"end-user/traits/more",
],
},
{
"Defining Policies": [
"end-user/policies/envbinding",
"end-user/policies/health",
],
},
{
"Designing Workflow": [
"end-user/workflow/built-in-workflow-defs",
"end-user/workflow/webhook-notification",
"end-user/workflow/component-dependency-parameter",
],
},
"case-studies/multi-cluster",
"end-user/version-control",
],
},
{
type: "category",
label: "Administrator Manuals",
label: "Extension",
collapsed: true,
items: [
{
@ -179,7 +200,7 @@ module.exports = {
items: [
{
type: "category",
label: "CLI",
label: "CLI Command",
items: [
"cli/vela_components",
"cli/vela_config",
@ -200,6 +221,26 @@ module.exports = {
"cli/vela_cap",
],
},
{
"Supported Cloud Resource": [
"end-user/components/cloud-services/terraform/alibaba-ack",
"end-user/components/cloud-services/terraform/alibaba-eip",
"end-user/components/cloud-services/terraform/alibaba-rds",
"end-user/components/cloud-services/terraform/alibaba-oss",
"end-user/components/cloud-services/terraform/alibaba-redis",
"end-user/components/cloud-services/terraform/alibaba-vpc",
"end-user/components/cloud-services/terraform/azure-database-mariadb",
"end-user/components/cloud-services/terraform/azure-storage-account",
"end-user/components/cloud-services/terraform/aws-s3",
],
},
{
"Built-in Component Type": [
"end-user/components/cue/webservice",
"end-user/components/cue/worker",
"end-user/components/cue/task",
],
},
],
},
{