diff --git a/README.md b/README.md index 278ad9642..1f325ce9d 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ ![alt](resources/KubeVela-03.png) -*Making shipping applications more enjoyable.* +*Make shipping applications more enjoyable.* # KubeVela diff --git a/docs/README.md b/docs/README.md index 21a41fb8c..0cdd846d4 100644 --- a/docs/README.md +++ b/docs/README.md @@ -8,9 +8,9 @@ Learn and use KubeVela with tutorials and user stories. - [Concepts](concepts.md) **For Developers** -- [Configuring Deployment Environment](developers/config-enviroments.md) +- [Setting Up Deployment Environment](developers/config-enviroments.md) - [Deploying Application](developers/deploy-app.md) -- [Visiting Application](developers/set-route.md) +- [Setting Routes](developers/set-route.md) - [Setting Auto-scaling Policy](developers/set-autoscaling.md) - [Setting Rollout Strategy](developers/set-rollout.md) - [Monitoring Application](developers/set-metrics.md) diff --git a/docs/developers/config-enviroments.md b/docs/developers/config-enviroments.md index 0d8b6691a..6edc37145 100644 --- a/docs/developers/config-enviroments.md +++ b/docs/developers/config-enviroments.md @@ -1,10 +1,11 @@ -# Configuring Deployment Environments +# Setting Up Deployment Environment Before working with your application, you need to prepare a deployment environment (e.g. test, staging, prod etc) which will configure the workspace, email for certificate issuer and domain for your application. ## Create environment > TODO `--namespace` and `--domain` should be able to skipped + > TODO why don't use xip.io as demo? ```console diff --git a/docs/developers/set-route.md b/docs/developers/set-route.md index e9d990b2a..66264eab3 100644 --- a/docs/developers/set-route.md +++ b/docs/developers/set-route.md @@ -1,4 +1,4 @@ -# Visiting Application +# Setting Routes Once your web services of the application is deployed, you can visit it from outside world via `route` feature. diff --git a/docs/install.md b/docs/install.md index 0946b8d09..23766a5e0 100644 --- a/docs/install.md +++ b/docs/install.md @@ -35,6 +35,10 @@ This command will install KubeVela server components in your Kubernetes cluster. > TODO Paste a output of successful installation here. +## Dependencies + +> TODO Describe how vela install handle Prometheus & Grafana, Flagger and KEDA, and what if user want to replace them with his own version. (It's fine to say KEDA, Flagger is a temporary fork and we will ship the fixes to upstreams very soon) + ## Clean Up