fix-resources-url (#1492)

This commit is contained in:
yangsoon
2021-04-14 23:50:07 +08:00
committed by GitHub
parent ce20f55382
commit 1659528015
44 changed files with 25 additions and 30 deletions
+2 -2
View File
@@ -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:
+4 -4
View File
@@ -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.
+1 -1
View File
@@ -1,4 +1,4 @@
![alt](../resources/KubeVela-03.png)
![alt](resources/KubeVela-03.png)
*Make shipping applications more enjoyable.*
+4 -4
View File
@@ -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.
+2 -2
View File
@@ -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:
+1 -1
View File
@@ -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)
</details>
+2 -2
View File
@@ -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.
+2 -2
View File
@@ -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:
+1 -1
View File
@@ -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.
+1 -1
View File
@@ -4,7 +4,7 @@ slug: /
---
![alt](../resources/KubeVela-01.png)
![alt](resources/KubeVela-01.png)
## Motivation
+3 -3
View File
@@ -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)
@@ -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

Before

Width:  |  Height:  |  Size: 82 KiB

After

Width:  |  Height:  |  Size: 82 KiB

Before

Width:  |  Height:  |  Size: 94 KiB

After

Width:  |  Height:  |  Size: 94 KiB

+1 -1
View File
@@ -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
Binary file not shown.

Before

Width:  |  Height:  |  Size: 2.9 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 3.8 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 5.3 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 2.7 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 3.5 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 4.8 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 99 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 139 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 57 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 374 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 137 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 132 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 395 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 62 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 194 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 198 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 217 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 90 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 65 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 236 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 27 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 211 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 108 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 290 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 206 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 478 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 622 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 506 KiB

-5
View File
@@ -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/