diff --git a/Makefile b/Makefile index 6711ed991..ae733afb1 100644 --- a/Makefile +++ b/Makefile @@ -74,10 +74,10 @@ docs-start: ifeq ($(wildcard git-page),) git clone --single-branch --depth 1 https://github.com/oam-dev/kubevela.io.git git-page endif - rm -r git-page/docs && rm -r git-page/resources + rm -r git-page/docs rm git-page/sidebars.js cat docs/sidebars.js > git-page/sidebars.js - cp -R docs/en git-page/docs && cp -R docs/resources git-page/resources + cp -R docs/en git-page/docs cd git-page && yarn install && yarn start api-gen: diff --git a/docs/README.md b/docs/README.md index 1122c2591..e92479abf 100644 --- a/docs/README.md +++ b/docs/README.md @@ -2,14 +2,14 @@ [Here](https://github.com/oam-dev/kubevela/tree/master/docs) is the source documentation of [Kubevela website](http://kubevela.io/). Any files modifid here will trigger the `check-docs` Github action to run and validate the docs could be build successfully into the website. -Any changes on these files(`docs/en/*`, `resource/*`, `sidebars.js`) will be submitted to the corresponding locations of the repo +Any changes on these files(`docs/en/*`, `docs/en/resource/*`, `sidebars.js`) will be submitted to the corresponding locations of the repo [kubevela.io](https://github.com/oam-dev/kubevela.io). The Github-Action there will parse the document and publish it to the Kubevela Website automatically. Please follow our guides below to learn how to write the docs in the right way. ## Add or Update Docs -When you add or modify the docs, these three files(`docs/en/`, `resource/` and `sidebars.js`) should be taken into consideration. +When you add or modify the docs, these three files(`docs/en/`, `docs/en/resource/` and `sidebars.js`) should be taken into consideration. 1. `docs/en/`, the main English documentation files are mainly located in this folder. All markdown files need to follow the format, that the title at the beginning should be in the following format: @@ -28,11 +28,11 @@ When you add or modify the docs, these three files(`docs/en/`, `resource/` and ` [the definition and template concepts](../platform-engineers/definition-and-templates) ``` -2. `resource/`, image files are located in this folder. When you want to use link any image in documentation, +2. `docs/en/resource/`, image files are located in this folder. When you want to use link any image in documentation, you should put the image resources here and use a relative path like below: ```markdown - ![alt](../resources/concepts.png) + ![alt](./resources/concepts.png) ``` 3. `sidebars.js`, this file contain the navigation information of the KubeVela website. diff --git a/docs/en/README.md b/docs/en/README.md index d99149c32..ae4e304e8 100644 --- a/docs/en/README.md +++ b/docs/en/README.md @@ -1,4 +1,4 @@ -![alt](../resources/KubeVela-03.png) +![alt](resources/KubeVela-03.png) *Make shipping applications more enjoyable.* diff --git a/docs/en/concepts.md b/docs/en/concepts.md index 38b3ffa4f..021f2f851 100644 --- a/docs/en/concepts.md +++ b/docs/en/concepts.md @@ -16,11 +16,11 @@ First of all, KubeVela introduces a workflow with separate of concerns as below: Below is how this workflow looks like: -![alt](../resources/how-it-works.png) +![alt](resources/how-it-works.png) This template based workflow make it possible for platform team enforce best practices and deployment confidence with a set of Kubernetes CRDs, and give end users a *PaaS-like* experience (*i.e. app-centric, higher level abstractions, self-service operations etc*) by natural. -![alt](../resources/what-is-kubevela.png) +![alt](resources/what-is-kubevela.png) Below are the core concepts in KubeVela that make this happen. @@ -93,12 +93,12 @@ Currently, a KubeVela `environment` only maps to a Kubernetes namespace, while t The main concepts of KubeVela could be shown as below: -![alt](../resources/concepts.png) +![alt](resources/concepts.png) ## Architecture The overall architecture of KubeVela is shown as below: -![alt](../resources/arch.png) +![alt](resources/arch.png) Specifically, the application controller is responsible for application abstraction and encapsulation (i.e. the controller for `Application` and `Definition`). The rollout controller will handle progressive rollout strategy with the whole application as a unit. The multi-cluster deployment engine is responsible for deploying the application across multiple clusters and environments with traffic shifting and rollout features supported. diff --git a/docs/en/developers/check-ref-doc.md b/docs/en/developers/check-ref-doc.md index add6c0146..a69ffdd5c 100644 --- a/docs/en/developers/check-ref-doc.md +++ b/docs/en/developers/check-ref-doc.md @@ -22,7 +22,7 @@ This command will automatically open the reference documentation for given workl Let's take `$ vela show webservice --web` as example. The detailed schema documentation for `Web Service` workload type will show up immediately as below: -![](../../resources/vela_show_webservice.jpg) +![](../resources/vela_show_webservice.jpg) Note that there's in the section named `Specification`, it even provides you with a full sample for the usage of this workload type with a fake name `my-service-name`. @@ -30,7 +30,7 @@ Note that there's in the section named `Specification`, it even provides you wit Similarly, we can also do `$ vela show autoscale --web`: -![](../../resources/vela_show_autoscale.jpg) +![](../resources/vela_show_autoscale.jpg) With these auto-generated reference documentations, we could easily complete the application description by simple copy-paste, for example: diff --git a/docs/en/developers/extensions/set-metrics.md b/docs/en/developers/extensions/set-metrics.md index 7145abc46..a589f6ac5 100644 --- a/docs/en/developers/extensions/set-metrics.md +++ b/docs/en/developers/extensions/set-metrics.md @@ -102,6 +102,6 @@ kubectl --namespace monitoring port-forward `kubectl -n monitoring get pods -l p Then access the Prometheus dashboard via http://localhost:9090/targets -![Prometheus Dashboard](../../../resources/metrics.jpg) +![Prometheus Dashboard](../../resources/metrics.jpg) diff --git a/docs/en/developers/extensions/set-rollout.md b/docs/en/developers/extensions/set-rollout.md index 58a23b07f..47acbc63a 100644 --- a/docs/en/developers/extensions/set-rollout.md +++ b/docs/en/developers/extensions/set-rollout.md @@ -149,14 +149,14 @@ Hello World -- This is rolling 02 In detail, `Rollout` controller will create a canary of your app , and then gradually shift traffic to the canary while measuring key performance indicators like HTTP requests success rate at the same time. -![alt](../../../resources/traffic-shifting-analysis.png) +![alt](../../resources/traffic-shifting-analysis.png) In this sample, for every `10s`, `5%` traffic will be shifted to canary from the primary, until the traffic on canary reached `50%`. At the mean time, the instance number of canary will automatically scale to `replicas: 2` per configured in Appfile. Based on analysis result of the KPIs during this traffic shifting, a canary will be promoted or aborted if analysis is failed. If promoting, the primary will be upgraded from v1 to v2, and traffic will be fully shifted back to the primary instances. So as result, canary instances will be deleted after the promotion finished. -![alt](../../../resources/promotion.png) +![alt](../../resources/promotion.png) > Note: KubeVela's `Rollout` trait is implemented with [Weaveworks Flagger](https://flagger.app/) operator. diff --git a/docs/en/developers/references/README.md b/docs/en/developers/references/README.md index f940372e9..d9f8648c7 100644 --- a/docs/en/developers/references/README.md +++ b/docs/en/developers/references/README.md @@ -20,13 +20,13 @@ This command will automatically open the reference documentation for given compo Let's take `$ vela show webservice --web` as example. The detailed schema documentation for `Web Service` component type will show up immediately as below: -![](../../../resources/vela_show_webservice.jpg) +![](../../resources/vela_show_webservice.jpg) Note that there's in the section named `Specification`, it even provides you with a full sample for the usage of this workload type with a fake name `my-service-name`. Similarly, we can also do `$ vela show autoscale`: -![](../../../resources/vela_show_autoscale.jpg) +![](../../resources/vela_show_autoscale.jpg) With these auto-generated reference documentations, we could easily complete the application description by simple copy-paste, for example: diff --git a/docs/en/developers/references/devex/faq.md b/docs/en/developers/references/devex/faq.md index bf4b55d1f..d59c939c1 100644 --- a/docs/en/developers/references/devex/faq.md +++ b/docs/en/developers/references/devex/faq.md @@ -270,7 +270,7 @@ Metrics server is already enabled. Metrics server has to be enabled in `Operations/Add-ons` section of [Alibaba Cloud console](https://cs.console.aliyun.com/) as below. -![](../../../../resources/install-metrics-server-in-ASK.jpg) +![](../../../resources/install-metrics-server-in-ASK.jpg) Please refer to [metrics server debug guide](https://help.aliyun.com/document_detail/176515.html) if you hit more issue. diff --git a/docs/en/introduction.md b/docs/en/introduction.md index aea466bbd..5c2d391eb 100644 --- a/docs/en/introduction.md +++ b/docs/en/introduction.md @@ -4,7 +4,7 @@ slug: / --- -![alt](../resources/KubeVela-01.png) +![alt](resources/KubeVela-01.png) ## Motivation diff --git a/docs/en/platform-engineers/cloud-services.md b/docs/en/platform-engineers/cloud-services.md index b0a1659e6..db7129afb 100644 --- a/docs/en/platform-engineers/cloud-services.md +++ b/docs/en/platform-engineers/cloud-services.md @@ -239,7 +239,7 @@ Handling connection for 80 Handling connection for 80 ``` -![](../../resources/crossplane-visit-application.jpg) +![](../resources/crossplane-visit-application.jpg) ## Provisioning and consuming cloud resource in a single application v2 (two cloud resources) @@ -347,7 +347,7 @@ Handling connection for 80 Handling connection for 80 ``` -![](../../resources/crossplane-visit-application-v2.jpg) +![](../resources/crossplane-visit-application-v2.jpg) ## Provisioning and consuming cloud resource in different applications @@ -552,4 +552,4 @@ $ kubectl port-forward deployment/express-server 80:80 We can see the cloud resource is successfully consumed by the application. -![](../../resources/crossplane-visit-application.jpg) +![](../resources/crossplane-visit-application.jpg) diff --git a/docs/en/platform-engineers/openapi-v3-json-schema.md b/docs/en/platform-engineers/openapi-v3-json-schema.md index cf63f9b4e..aec0c9a09 100644 --- a/docs/en/platform-engineers/openapi-v3-json-schema.md +++ b/docs/en/platform-engineers/openapi-v3-json-schema.md @@ -60,7 +60,7 @@ You can render above schema into a form by [form-render](https://github.com/alib Below is a form rendered with `form-render`: -![](../../resources/json-schema-render-example.jpg) +![](../resources/json-schema-render-example.jpg) # What's Next diff --git a/docs/resources/crossplane-visit-application-v2.jpg b/docs/en/resources/crossplane-visit-application-v2.jpg similarity index 100% rename from docs/resources/crossplane-visit-application-v2.jpg rename to docs/en/resources/crossplane-visit-application-v2.jpg diff --git a/docs/resources/crossplane-visit-application.jpg b/docs/en/resources/crossplane-visit-application.jpg similarity index 100% rename from docs/resources/crossplane-visit-application.jpg rename to docs/en/resources/crossplane-visit-application.jpg diff --git a/docs/en/rollout/rollout.md b/docs/en/rollout/rollout.md index 7e2c24025..373753563 100644 --- a/docs/en/rollout/rollout.md +++ b/docs/en/rollout/rollout.md @@ -154,7 +154,7 @@ Here is the end to end user experience based on [CloneSet](https://openkruise.io ## State Transition Here is the high level state transition graph -![](../../resources/approllout-status-transition.jpg) +![](../resources/approllout-status-transition.jpg) ## Roadmap diff --git a/docs/resources/KubeVela-01.png b/docs/resources/KubeVela-01.png deleted file mode 100644 index f48cd4873..000000000 Binary files a/docs/resources/KubeVela-01.png and /dev/null differ diff --git a/docs/resources/KubeVela-02.png b/docs/resources/KubeVela-02.png deleted file mode 100644 index 1c297828c..000000000 Binary files a/docs/resources/KubeVela-02.png and /dev/null differ diff --git a/docs/resources/KubeVela-03.png b/docs/resources/KubeVela-03.png deleted file mode 100644 index 1e4f1171f..000000000 Binary files a/docs/resources/KubeVela-03.png and /dev/null differ diff --git a/docs/resources/KubeVela-04.png b/docs/resources/KubeVela-04.png deleted file mode 100644 index bc50f5a9b..000000000 Binary files a/docs/resources/KubeVela-04.png and /dev/null differ diff --git a/docs/resources/KubeVela-05.png b/docs/resources/KubeVela-05.png deleted file mode 100644 index cf9d3a330..000000000 Binary files a/docs/resources/KubeVela-05.png and /dev/null differ diff --git a/docs/resources/KubeVela-06.png b/docs/resources/KubeVela-06.png deleted file mode 100644 index 8e77d6b54..000000000 Binary files a/docs/resources/KubeVela-06.png and /dev/null differ diff --git a/docs/resources/api-arch.jpg b/docs/resources/api-arch.jpg deleted file mode 100644 index e7007c133..000000000 Binary files a/docs/resources/api-arch.jpg and /dev/null differ diff --git a/docs/resources/api-workflow.png b/docs/resources/api-workflow.png deleted file mode 100644 index bc43dc117..000000000 Binary files a/docs/resources/api-workflow.png and /dev/null differ diff --git a/docs/resources/apiserver-arch.jpg b/docs/resources/apiserver-arch.jpg deleted file mode 100644 index de8974f25..000000000 Binary files a/docs/resources/apiserver-arch.jpg and /dev/null differ diff --git a/docs/resources/app-centric.png b/docs/resources/app-centric.png deleted file mode 100644 index bd3e6d4b0..000000000 Binary files a/docs/resources/app-centric.png and /dev/null differ diff --git a/docs/resources/appfile.png b/docs/resources/appfile.png deleted file mode 100644 index c21ad8454..000000000 Binary files a/docs/resources/appfile.png and /dev/null differ diff --git a/docs/resources/approllout-status-transition.jpg b/docs/resources/approllout-status-transition.jpg deleted file mode 100644 index ba2756880..000000000 Binary files a/docs/resources/approllout-status-transition.jpg and /dev/null differ diff --git a/docs/resources/arch.png b/docs/resources/arch.png deleted file mode 100644 index bb0efcff7..000000000 Binary files a/docs/resources/arch.png and /dev/null differ diff --git a/docs/resources/catalog-workflow.jpg b/docs/resources/catalog-workflow.jpg deleted file mode 100644 index 33957a421..000000000 Binary files a/docs/resources/catalog-workflow.jpg and /dev/null differ diff --git a/docs/resources/coa.png b/docs/resources/coa.png deleted file mode 100644 index e1062354c..000000000 Binary files a/docs/resources/coa.png and /dev/null differ diff --git a/docs/resources/concepts.png b/docs/resources/concepts.png deleted file mode 100644 index 347d1796f..000000000 Binary files a/docs/resources/concepts.png and /dev/null differ diff --git a/docs/resources/how-it-works.png b/docs/resources/how-it-works.png deleted file mode 100644 index beb854242..000000000 Binary files a/docs/resources/how-it-works.png and /dev/null differ diff --git a/docs/resources/install-metrics-server-in-ASK.jpg b/docs/resources/install-metrics-server-in-ASK.jpg deleted file mode 100644 index 56140887c..000000000 Binary files a/docs/resources/install-metrics-server-in-ASK.jpg and /dev/null differ diff --git a/docs/resources/json-schema-render-example.jpg b/docs/resources/json-schema-render-example.jpg deleted file mode 100644 index 245563cc0..000000000 Binary files a/docs/resources/json-schema-render-example.jpg and /dev/null differ diff --git a/docs/resources/kubevela-runtime.png b/docs/resources/kubevela-runtime.png deleted file mode 100644 index a91b94ed2..000000000 Binary files a/docs/resources/kubevela-runtime.png and /dev/null differ diff --git a/docs/resources/kubewatch-notif.jpg b/docs/resources/kubewatch-notif.jpg deleted file mode 100644 index 54eacf4da..000000000 Binary files a/docs/resources/kubewatch-notif.jpg and /dev/null differ diff --git a/docs/resources/metrics.jpg b/docs/resources/metrics.jpg deleted file mode 100644 index af51b9eab..000000000 Binary files a/docs/resources/metrics.jpg and /dev/null differ diff --git a/docs/resources/openfaas.jpg b/docs/resources/openfaas.jpg deleted file mode 100644 index b97e81f19..000000000 Binary files a/docs/resources/openfaas.jpg and /dev/null differ diff --git a/docs/resources/promotion.png b/docs/resources/promotion.png deleted file mode 100644 index a66f87d8a..000000000 Binary files a/docs/resources/promotion.png and /dev/null differ diff --git a/docs/resources/traffic-shifting-analysis.png b/docs/resources/traffic-shifting-analysis.png deleted file mode 100644 index 1001d851f..000000000 Binary files a/docs/resources/traffic-shifting-analysis.png and /dev/null differ diff --git a/docs/resources/vela_show_autoscale.jpg b/docs/resources/vela_show_autoscale.jpg deleted file mode 100644 index e14896e15..000000000 Binary files a/docs/resources/vela_show_autoscale.jpg and /dev/null differ diff --git a/docs/resources/vela_show_webservice.jpg b/docs/resources/vela_show_webservice.jpg deleted file mode 100644 index ee9130615..000000000 Binary files a/docs/resources/vela_show_webservice.jpg and /dev/null differ diff --git a/docs/resources/what-is-kubevela.png b/docs/resources/what-is-kubevela.png deleted file mode 100644 index 28b391ca1..000000000 Binary files a/docs/resources/what-is-kubevela.png and /dev/null differ diff --git a/hack/website/test-build.sh b/hack/website/test-build.sh index 858744ed9..9af36fe7b 100644 --- a/hack/website/test-build.sh +++ b/hack/website/test-build.sh @@ -28,11 +28,6 @@ echo "clear en docs" rm -r git-page/docs/* echo "clear zh docs" rm -r git-page/i18n/zh/docusaurus-plugin-content-docs/* -echo "clear resources" -rm -r git-page/resources/* - -echo "update resources" -cp -R ${docs_path}/resources/* git-page/resources/ echo "update docs" cp -R ${docs_path}/en/* git-page/docs/