refactor docs into 2 layers

2026-08-19 04:26:39 +00:00 · 2021-03-18 15:37:57 +08:00
parent bdd2916972
commit fdeedb31be
1 changed files with 64 additions and 81 deletions
@@ -7,90 +7,73 @@
  - [Core Concepts](/en/concepts.md)

 - Learning KubeVela 
-  - Application CRD
-    - [Introduction](/en/platform-engineers/overview.md)
-    - [Designing Application](/en/application.md)
-  - Managing Components and Traits
-    - [Definitions](/en/platform-engineers/definition-and-templates.md)
-    - CUE
-      - [CUE Basic](/en/cue/basic.md)
-      - [Workload Type](/en/cue/workload-type.md)
-      - [Trait](/en/cue/trait.md)
-      - [Advanced Features](/en/cue/status.md)
-    - Helm
-      - [Workload Type](/en/helm/component.md)
-      - [Trait](/en/helm/trait.md)
-      - [Limitations](/en/helm/known-issues.md)
-    - How-to (Out-of-dated)
-      - [Defining Workload Type](/en/platform-engineers/workload-type.md)
-      - [Defining Trait](/en/platform-engineers/trait.md)
-      - [Defining Cloud Service](/en/platform-engineers/cloud-services.md)
+  - [Introduction](/en/platform-engineers/overview.md)
+  - [Designing Application](/en/application.md)
+
+- Managing Components and Traits
+  - [Definitions](/en/platform-engineers/definition-and-templates.md)
+  - [CUE Basic](/en/cue/basic.md)
+  - [CUE Based Workload Type](/en/cue/workload-type.md)
+  - [CUE Based Trait](/en/cue/trait.md)
+  - [CUE Based Advanced Features](/en/cue/status.md)
+  - [Helm Based Workload Type](/en/helm/component.md)
+  - [Helm Based Trait](/en/helm/trait.md)
+  - [Helm Based Workload Limitations](/en/helm/known-issues.md)
+
+- How-to (Out-of-dated)
+  - [Defining Workload Type](/en/platform-engineers/workload-type.md)
+  - [Defining Trait](/en/platform-engineers/trait.md)
+  - [Defining Cloud Service](/en/platform-engineers/cloud-services.md)

 - Roadmap
  - [KubeVela Roadmap](/en/roadmap.md)

- References
+- Developer Experience 
+  - [Overview](/en/quick-start-appfile.md)
+  - [Appfile](/en/developers/learn-appfile.md)
+  - [Port Forwarding](/en/developers/port-forward.md)
+  - [Check Application Logs](/en/developers/check-logs.md)
+  - [Execute Commands in Container](/en/developers/exec-cmd.md)
+  - Extending
+  - [Managing Capabilities](/en/developers/cap-center.md)
+  - [Setting Routes](/en/developers/extensions/set-route.md)
+  - [Setting Auto-scaling Policy](/en/developers/extensions/set-autoscale.md)
+  - [Setting Rollout Strategy](/en/developers/extensions/set-rollout.md)
+  - [Setting Monitoring Policy](/en/developers/extensions/set-metrics.md)
+  - [Setting Up Deployment Environment](/en/developers/config-enviroments.md)
+  - [Configuring data/env in Application](/en/developers/config-app.md)
+  - [Alternative Commands](/en/developers/alternative-cmd.md)
+
+- Vela CLI
+  - [vela config](/en/cli/vela_config.md)
+  - [vela env](/en/cli/vela_env.md)
+  - [vela init](/en/cli/vela_init.md)
+  - [vela up](/en/cli/vela_up.md)
+  - [vela version](/en/cli/vela_version.md)
+  - [vela delete](/en/cli/vela_delete.md)
+  - [vela exec](/en/cli/vela_exec.md)
+  - [vela logs](/en/cli/vela_logs.md)
+  - [vela ls](/en/cli/vela_ls.md)
+  - [vela port-forward](/en/cli/vela_port-forward.md)
+  - [vela show](/en/cli/vela_show.md)
+  - [vela status](/en/cli/vela_status.md)
+  - [check existing vela workloads](/en/cli/vela_workloads.md)
+  - [check existing vela traits](/en/cli/vela_traits.md)
+  - [vela system](/en/cli/vela_system.md)
+  - [vela template](/en/cli/vela_template.md)
+  - [vela cap](/en/cli/vela_cap.md)
+  
+- API References
  - [Capabilities](/en/developers/references/README.md)
-    - Workload Types
-      - [Web Service](/en/developers/references/workload-types/webservice.md)
-      - [Task](/en/developers/references/workload-types/task.md)
-      - [Worker](/en/developers/references/workload-types/worker.md)
-    - Traits
-      - [Route](/en/developers/references/traits/route.md)
-      - [Autoscale](/en/developers/references/traits/autoscale.md)
-      - [Rollout](/en/developers/references/traits/rollout.md)
-      - [Metrics](/en/developers/references/traits/metrics.md)
-      - [Scaler](/en/developers/references/traits/scaler.md)
-    - [Restful API](/en/developers/references/restful-api/index.html ':ignore')
-  - CLI
-    - General
-      - [vela config](/en/cli/vela_config.md)
-      - [vela env](/en/cli/vela_env.md)
-      - [vela init](/en/cli/vela_init.md)
-      - [vela install](/en/cli/vela_install.md)
-      - [vela up](/en/cli/vela_up.md)
-      - [vela version](/en/cli/vela_version.md)
-    - Applications
-      - [vela delete](/en/cli/vela_delete.md)
-      - [vela exec](/en/cli/vela_exec.md)
-      - [vela logs](/en/cli/vela_logs.md)
-      - [vela ls](/en/cli/vela_ls.md)
-      - [vela port-forward](/en/cli/vela_port-forward.md)
-      - [vela show](/en/cli/vela_show.md)
-      - [vela status](/en/cli/vela_status.md)
-      - [vela svc](/en/cli/vela_svc.md)
-    - Workload Types
-      - [vela workloads](/en/cli/vela_workloads.md)
-    - Traits
-      - [vela traits](/en/cli/vela_traits.md)
-      - [vela scaler](/en/cli/vela_scaler.md)
-      - [vela route](/en/cli/vela_route.md)
-      - [vela autoscale](/en/cli/vela_autoscale.md)
-      - [vela rollout](/en/cli/vela_rollout.md)
-      - [vela metrics](/en/cli/vela_metrics.md)
-    - System
-      - [vela completion](/en/cli/vela_completion.md)
-      - [vela dashboard](/en/cli/vela_dashboard.md)
-      - [vela system](/en/cli/vela_system.md)
-      - [vela template](/en/cli/vela_template.md)
-    - Extensibility
-      - [vela cap](/en/cli/vela_cap.md)
-  - Developer Experience
-    - [Overview](/en/quick-start-appfile.md)
-    - [Appfile](/en/developers/learn-appfile.md)
-    - CLI
-      - Debugging
-        - [Port Forwarding](/en/developers/port-forward.md)
-        - [Check Application Logs](/en/developers/check-logs.md)
-        - [Execute Commands in Container](/en/developers/exec-cmd.md)  
-      - Extending
-        - [Managing Capabilities](/en/developers/cap-center.md)
-        - [Setting Routes](/en/developers/extensions/set-route.md)
-        - [Setting Auto-scaling Policy](/en/developers/extensions/set-autoscale.md)
-        - [Setting Rollout Strategy](/en/developers/extensions/set-rollout.md)
-        - [Setting Monitoring Policy](/en/developers/extensions/set-metrics.md)
-      - Configuring
-        - [Setting Up Deployment Environment](/en/developers/config-enviroments.md)
-        - [Configuring data/env in Application](/en/developers/config-app.md)
-      - [Alternative Commands](/en/developers/alternative-cmd.md)
+  - [Web Service](/en/developers/references/workload-types/webservice.md)
+  - [Task](/en/developers/references/workload-types/task.md)
+  - [Worker](/en/developers/references/workload-types/worker.md)
+  - [Route](/en/developers/references/traits/route.md)
+  - [Autoscale](/en/developers/references/traits/autoscale.md)
+  - [Rollout](/en/developers/references/traits/rollout.md)
+  - [Metrics](/en/developers/references/traits/metrics.md)
+  - [Scaler](/en/developers/references/traits/scaler.md)
+  - [Restful API](/en/developers/references/restful-api/index.html ':ignore')
+
+
 - [FAQ](/en/developers/references/devex/faq.md)