From 756eab6e581c2e2dd89a3046d8aba2bf6b6b4f73 Mon Sep 17 00:00:00 2001 From: FogDong Date: Tue, 3 Aug 2021 20:14:41 +0800 Subject: [PATCH] Fix(typo): fix typos in docs --- docs/developers/config-enviroments.md | 2 +- docs/end-user/pipeline.md | 2 +- docs/getting-started/quick-install.mdx | 2 +- docs/platform-engineers/components/component-cue.md | 4 ++-- docs/platform-engineers/cue/basic.md | 2 +- docs/platform-engineers/cue/cross-namespace-resource.md | 2 +- docs/platform-engineers/definition-and-templates.md | 8 ++++---- docs/platform-engineers/traits/status.md | 2 +- .../current/developers/config-enviroments.md | 2 +- .../current/end-user/pipeline.md | 2 +- .../platform-engineers/components/component-cue.md | 4 ++-- .../current/platform-engineers/cue/advanced.md | 2 +- .../platform-engineers/cue/cross-namespace-resource.md | 2 +- .../current/platform-engineers/traits/status.md | 2 +- .../version-v1.0/developers/config-enviroments.md | 2 +- .../version-v1.0/end-user/pipeline.md | 2 +- .../version-v1.0/end-user/scopes/canary.md | 2 +- .../version-v1.0/platform-engineers/cue/component.md | 4 ++-- .../platform-engineers/cue/cross-namespace-resource.md | 2 +- .../version-v1.0/platform-engineers/cue/status.md | 4 ++-- .../version-v1.0/developers/config-enviroments.md | 2 +- versioned_docs/version-v1.0/end-user/pipeline.md | 2 +- versioned_docs/version-v1.0/install.mdx | 2 +- .../version-v1.0/platform-engineers/cue/basic.md | 2 +- .../version-v1.0/platform-engineers/cue/component.md | 4 ++-- .../platform-engineers/cue/cross-namespace-resource.md | 2 +- .../version-v1.0/platform-engineers/cue/status.md | 4 ++-- .../platform-engineers/definition-and-templates.md | 8 ++++---- .../version-v1.0/platform-engineers/overview.md | 2 +- .../version-v1.1/developers/config-enviroments.md | 2 +- versioned_docs/version-v1.1/end-user/pipeline.md | 2 +- versioned_docs/version-v1.1/install.mdx | 2 +- .../version-v1.1/platform-engineers/cue/basic.md | 2 +- .../version-v1.1/platform-engineers/cue/component.md | 4 ++-- .../platform-engineers/cue/cross-namespace-resource.md | 2 +- .../version-v1.1/platform-engineers/cue/status.md | 2 +- .../platform-engineers/definition-and-templates.md | 8 ++++---- 37 files changed, 53 insertions(+), 53 deletions(-) diff --git a/docs/developers/config-enviroments.md b/docs/developers/config-enviroments.md index 28594bd1..7c658853 100644 --- a/docs/developers/config-enviroments.md +++ b/docs/developers/config-enviroments.md @@ -88,7 +88,7 @@ Since you now have domain configured globally in deployment environment, you don ```yaml # in demo environment -servcies: +services: express-server: ... diff --git a/docs/end-user/pipeline.md b/docs/end-user/pipeline.md index 269b0f87..9e307904 100644 --- a/docs/end-user/pipeline.md +++ b/docs/end-user/pipeline.md @@ -4,5 +4,5 @@ title: Build CI/CD Pipeline TBD, Content Overview: -1. install argo/teckton. +1. install argo/tekton. 2. run the pipeline example: https://github.com/oam-dev/kubevela/tree/master/docs/examples/argo \ No newline at end of file diff --git a/docs/getting-started/quick-install.mdx b/docs/getting-started/quick-install.mdx index 7d71e645..432ab738 100644 --- a/docs/getting-started/quick-install.mdx +++ b/docs/getting-started/quick-install.mdx @@ -22,7 +22,7 @@ className="unique-tabs" defaultValue="minikube" values={[ {label: 'Minikube', value: 'minikube'}, -{label: 'KinD', value: 'kind'}, +{label: 'Kind', value: 'kind'}, ]}> diff --git a/docs/platform-engineers/components/component-cue.md b/docs/platform-engineers/components/component-cue.md index 0e2bc24b..18a47b6c 100644 --- a/docs/platform-engineers/components/component-cue.md +++ b/docs/platform-engineers/components/component-cue.md @@ -96,7 +96,7 @@ spec: } ``` -Save above `ComponentDefintion` objects to files and install them to your Kubernetes cluster by `$ kubectl apply -f stateless-def.yaml task-def.yaml` +Save above `ComponentDefinition` objects to files and install them to your Kubernetes cluster by `$ kubectl apply -f stateless-def.yaml task-def.yaml` ## Declare an `Application` @@ -173,7 +173,7 @@ spec: ## CUE `Context` -KubeVela allows you to reference the runtime information of your application via `conext` keyword. +KubeVela allows you to reference the runtime information of your application via `context` keyword. The most widely used context is application name(`context.appName`) component name(`context.name`). diff --git a/docs/platform-engineers/cue/basic.md b/docs/platform-engineers/cue/basic.md index cc0c0c96..eea3ab33 100644 --- a/docs/platform-engineers/cue/basic.md +++ b/docs/platform-engineers/cue/basic.md @@ -394,7 +394,7 @@ price: 200 feel: "bad" ``` -Another example is to use bool type as prameter. +Another example is to use bool type as parameter. ``` parameter: { diff --git a/docs/platform-engineers/cue/cross-namespace-resource.md b/docs/platform-engineers/cue/cross-namespace-resource.md index 943b0b7b..21773bb1 100644 --- a/docs/platform-engineers/cue/cross-namespace-resource.md +++ b/docs/platform-engineers/cue/cross-namespace-resource.md @@ -7,7 +7,7 @@ In this section, we will introduce how to use cue template create resources in d By default, the `metadata.namespace` of K8s resource in CUE template is automatically filled with the same namespace of the application. If you want to create K8s resources running in a specific namespace witch is different with the application, you can set the `metadata.namespace` field. -KubeVela will create the resources in the specified namespace, and create a resourceTracker object as owener of those resources. +KubeVela will create the resources in the specified namespace, and create a resourceTracker object as owner of those resources. ## Usage diff --git a/docs/platform-engineers/definition-and-templates.md b/docs/platform-engineers/definition-and-templates.md index cf0ee168..e9167cd9 100644 --- a/docs/platform-engineers/definition-and-templates.md +++ b/docs/platform-engineers/definition-and-templates.md @@ -82,15 +82,15 @@ Let's explain them in detail. This field defines the constraints that what kinds of workloads this trait is allowed to apply to. - It accepts an array of string as value. -- Each item in the array refers to one or a group of workload types to which this trait is allowded to apply. +- Each item in the array refers to one or a group of workload types to which this trait is allowed to apply. There are three approaches to denote one or a group of workload types. - `ComponentDefinition` definition reference (CRD name), e.g., `deployments.apps` -- Resource group of `ComponentDefinition` definition reference prefixed with `*.`, e.g., `*.apps`, `*.oam.dev`. This means the trait is allowded to apply to any workloads in this group. -- `*` means this trait is allowded to apply to any workloads +- Resource group of `ComponentDefinition` definition reference prefixed with `*.`, e.g., `*.apps`, `*.oam.dev`. This means the trait is allowed to apply to any workloads in this group. +- `*` means this trait is allowed to apply to any workloads -If this field is omitted, it means this trait is allowded to apply to any workload types. +If this field is omitted, it means this trait is allowed to apply to any workload types. KubeVela will raise an error if a trait is applied to a workload type which is NOT included in the `appliesToWorkloads`. diff --git a/docs/platform-engineers/traits/status.md b/docs/platform-engineers/traits/status.md index e82e5934..7b09b22c 100644 --- a/docs/platform-engineers/traits/status.md +++ b/docs/platform-engineers/traits/status.md @@ -111,7 +111,7 @@ context:{ } ``` -Trait will not have the `context.ouput`, other fields are the same. +Trait will not have the `context.output`, other fields are the same. Please refer to [this doc](https://github.com/oam-dev/kubevela/blob/master/docs/examples/app-with-status/template.yaml) for the complete example. diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/developers/config-enviroments.md b/i18n/zh/docusaurus-plugin-content-docs/current/developers/config-enviroments.md index c3e34cb0..b9a5fab7 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/current/developers/config-enviroments.md +++ b/i18n/zh/docusaurus-plugin-content-docs/current/developers/config-enviroments.md @@ -72,7 +72,7 @@ environment demo updated, Namespace: demo, Email: my@email.com ```yaml # in demo environment -servcies: +services: express-server: ... diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/end-user/pipeline.md b/i18n/zh/docusaurus-plugin-content-docs/current/end-user/pipeline.md index 269b0f87..9e307904 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/current/end-user/pipeline.md +++ b/i18n/zh/docusaurus-plugin-content-docs/current/end-user/pipeline.md @@ -4,5 +4,5 @@ title: Build CI/CD Pipeline TBD, Content Overview: -1. install argo/teckton. +1. install argo/tekton. 2. run the pipeline example: https://github.com/oam-dev/kubevela/tree/master/docs/examples/argo \ No newline at end of file diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/platform-engineers/components/component-cue.md b/i18n/zh/docusaurus-plugin-content-docs/current/platform-engineers/components/component-cue.md index fb5d024b..946559ce 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/current/platform-engineers/components/component-cue.md +++ b/i18n/zh/docusaurus-plugin-content-docs/current/platform-engineers/components/component-cue.md @@ -96,7 +96,7 @@ spec: } ``` -Save above `ComponentDefintion` objects to files and install them to your Kubernetes cluster by `$ kubectl apply -f stateless-def.yaml task-def.yaml` +Save above `ComponentDefinition` objects to files and install them to your Kubernetes cluster by `$ kubectl apply -f stateless-def.yaml task-def.yaml` ## Declare an `Application` @@ -173,7 +173,7 @@ spec: ## CUE `Context` -KubeVela allows you to reference the runtime information of your application via `conext` keyword. +KubeVela allows you to reference the runtime information of your application via `context` keyword. The most widely used context is application name(`context.appName`) component name(`context.name`). diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/platform-engineers/cue/advanced.md b/i18n/zh/docusaurus-plugin-content-docs/current/platform-engineers/cue/advanced.md index c35465f0..f500b2b9 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/current/platform-engineers/cue/advanced.md +++ b/i18n/zh/docusaurus-plugin-content-docs/current/platform-engineers/cue/advanced.md @@ -96,7 +96,7 @@ spec: } ``` -将上面的 `ComponentDefintion` 对象保存到文件中,并通过 `$ kubectl apply -f stateless-def.yaml task-def.yaml` 将它们安装到你的 Kubernetes 集群。 +将上面的 `ComponentDefinition` 对象保存到文件中,并通过 `$ kubectl apply -f stateless-def.yaml task-def.yaml` 将它们安装到你的 Kubernetes 集群。 ## 声明一个 `Application` diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/platform-engineers/cue/cross-namespace-resource.md b/i18n/zh/docusaurus-plugin-content-docs/current/platform-engineers/cue/cross-namespace-resource.md index 4fa19f3c..4140b66f 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/current/platform-engineers/cue/cross-namespace-resource.md +++ b/i18n/zh/docusaurus-plugin-content-docs/current/platform-engineers/cue/cross-namespace-resource.md @@ -7,7 +7,7 @@ In this section, we will introduce how to use cue template create resources (wor By default, the `metadata.namespace` of K8s resource in CuE template is automatically filled with the same namespace of the applicaiton. If you want to create K8s resources running in a specific namespace witch is different with the application, you can set the `metadata.namespace` field. -KubeVela will create the resources in the specified namespace, and create a resourceTracker object as owener of those resources. +KubeVela will create the resources in the specified namespace, and create a resourceTracker object as owner of those resources. ## Usage diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/platform-engineers/traits/status.md b/i18n/zh/docusaurus-plugin-content-docs/current/platform-engineers/traits/status.md index cba3ff6a..c17def8e 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/current/platform-engineers/traits/status.md +++ b/i18n/zh/docusaurus-plugin-content-docs/current/platform-engineers/traits/status.md @@ -111,7 +111,7 @@ context:{ } ``` -Trait will not have the `context.ouput`, other fields are the same. +Trait will not have the `context.output`, other fields are the same. Please refer to [this doc](https://github.com/oam-dev/kubevela/blob/master/docs/examples/app-with-status/template.yaml) for the complete example. diff --git a/i18n/zh/docusaurus-plugin-content-docs/version-v1.0/developers/config-enviroments.md b/i18n/zh/docusaurus-plugin-content-docs/version-v1.0/developers/config-enviroments.md index c3e34cb0..b9a5fab7 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/version-v1.0/developers/config-enviroments.md +++ b/i18n/zh/docusaurus-plugin-content-docs/version-v1.0/developers/config-enviroments.md @@ -72,7 +72,7 @@ environment demo updated, Namespace: demo, Email: my@email.com ```yaml # in demo environment -servcies: +services: express-server: ... diff --git a/i18n/zh/docusaurus-plugin-content-docs/version-v1.0/end-user/pipeline.md b/i18n/zh/docusaurus-plugin-content-docs/version-v1.0/end-user/pipeline.md index 269b0f87..9e307904 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/version-v1.0/end-user/pipeline.md +++ b/i18n/zh/docusaurus-plugin-content-docs/version-v1.0/end-user/pipeline.md @@ -4,5 +4,5 @@ title: Build CI/CD Pipeline TBD, Content Overview: -1. install argo/teckton. +1. install argo/tekton. 2. run the pipeline example: https://github.com/oam-dev/kubevela/tree/master/docs/examples/argo \ No newline at end of file diff --git a/i18n/zh/docusaurus-plugin-content-docs/version-v1.0/end-user/scopes/canary.md b/i18n/zh/docusaurus-plugin-content-docs/version-v1.0/end-user/scopes/canary.md index b1753875..76fe5944 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/version-v1.0/end-user/scopes/canary.md +++ b/i18n/zh/docusaurus-plugin-content-docs/version-v1.0/end-user/scopes/canary.md @@ -11,7 +11,7 @@ Configures Canary deployment strategy for your application. List of all configuration options for a `Rollout` trait. ```yaml -servcies: +services: express-server: ... diff --git a/i18n/zh/docusaurus-plugin-content-docs/version-v1.0/platform-engineers/cue/component.md b/i18n/zh/docusaurus-plugin-content-docs/version-v1.0/platform-engineers/cue/component.md index c6b79f86..f80366cb 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/version-v1.0/platform-engineers/cue/component.md +++ b/i18n/zh/docusaurus-plugin-content-docs/version-v1.0/platform-engineers/cue/component.md @@ -96,7 +96,7 @@ spec: } ``` -Save above `ComponentDefintion` objects to files and install them to your Kubernetes cluster by `$ kubectl apply -f stateless-def.yaml task-def.yaml` +Save above `ComponentDefinition` objects to files and install them to your Kubernetes cluster by `$ kubectl apply -f stateless-def.yaml task-def.yaml` ## Declare an `Application` @@ -173,7 +173,7 @@ spec: ## CUE `Context` -KubeVela allows you to reference the runtime information of your application via `conext` keyword. +KubeVela allows you to reference the runtime information of your application via `context` keyword. The most widely used context is application name(`context.appName`) component name(`context.name`). diff --git a/i18n/zh/docusaurus-plugin-content-docs/version-v1.0/platform-engineers/cue/cross-namespace-resource.md b/i18n/zh/docusaurus-plugin-content-docs/version-v1.0/platform-engineers/cue/cross-namespace-resource.md index 4fa19f3c..4140b66f 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/version-v1.0/platform-engineers/cue/cross-namespace-resource.md +++ b/i18n/zh/docusaurus-plugin-content-docs/version-v1.0/platform-engineers/cue/cross-namespace-resource.md @@ -7,7 +7,7 @@ In this section, we will introduce how to use cue template create resources (wor By default, the `metadata.namespace` of K8s resource in CuE template is automatically filled with the same namespace of the applicaiton. If you want to create K8s resources running in a specific namespace witch is different with the application, you can set the `metadata.namespace` field. -KubeVela will create the resources in the specified namespace, and create a resourceTracker object as owener of those resources. +KubeVela will create the resources in the specified namespace, and create a resourceTracker object as owner of those resources. ## Usage diff --git a/i18n/zh/docusaurus-plugin-content-docs/version-v1.0/platform-engineers/cue/status.md b/i18n/zh/docusaurus-plugin-content-docs/version-v1.0/platform-engineers/cue/status.md index 23e68f24..7fccb303 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/version-v1.0/platform-engineers/cue/status.md +++ b/i18n/zh/docusaurus-plugin-content-docs/version-v1.0/platform-engineers/cue/status.md @@ -27,7 +27,7 @@ context:{ } ``` -Trait 并不包含 `context.ouput` 字段,其他字段都是相同。 +Trait 并不包含 `context.output` 字段,其他字段都是相同。 以下为健康检查的示例: @@ -110,7 +110,7 @@ context:{ } ``` -Trait 并不包含 `context.ouput` 字段,其他字段都是相同。 +Trait 并不包含 `context.output` 字段,其他字段都是相同。 Component 健康检查示例请参考 [这篇文章](https://github.com/oam-dev/kubevela/blob/master/docs/examples/app-with-status/template.yaml) 。 diff --git a/versioned_docs/version-v1.0/developers/config-enviroments.md b/versioned_docs/version-v1.0/developers/config-enviroments.md index 0efb7cbc..7444f9da 100644 --- a/versioned_docs/version-v1.0/developers/config-enviroments.md +++ b/versioned_docs/version-v1.0/developers/config-enviroments.md @@ -76,7 +76,7 @@ Since you now have domain configured globally in deployment environment, you don ```yaml # in demo environment -servcies: +services: express-server: ... diff --git a/versioned_docs/version-v1.0/end-user/pipeline.md b/versioned_docs/version-v1.0/end-user/pipeline.md index 269b0f87..9e307904 100644 --- a/versioned_docs/version-v1.0/end-user/pipeline.md +++ b/versioned_docs/version-v1.0/end-user/pipeline.md @@ -4,5 +4,5 @@ title: Build CI/CD Pipeline TBD, Content Overview: -1. install argo/teckton. +1. install argo/tekton. 2. run the pipeline example: https://github.com/oam-dev/kubevela/tree/master/docs/examples/argo \ No newline at end of file diff --git a/versioned_docs/version-v1.0/install.mdx b/versioned_docs/version-v1.0/install.mdx index 257089af..c5e0bc28 100644 --- a/versioned_docs/version-v1.0/install.mdx +++ b/versioned_docs/version-v1.0/install.mdx @@ -22,7 +22,7 @@ className="unique-tabs" defaultValue="minikube" values={[ {label: 'Minikube', value: 'minikube'}, -{label: 'KinD', value: 'kind'}, +{label: 'Kind', value: 'kind'}, ]}> diff --git a/versioned_docs/version-v1.0/platform-engineers/cue/basic.md b/versioned_docs/version-v1.0/platform-engineers/cue/basic.md index c5e8347a..16042f7e 100644 --- a/versioned_docs/version-v1.0/platform-engineers/cue/basic.md +++ b/versioned_docs/version-v1.0/platform-engineers/cue/basic.md @@ -374,7 +374,7 @@ price: 200 feel: "bad" ``` -Another example is to use bool type as prameter. +Another example is to use bool type as parameter. ``` parameter: { diff --git a/versioned_docs/version-v1.0/platform-engineers/cue/component.md b/versioned_docs/version-v1.0/platform-engineers/cue/component.md index 3802f8fd..1330fbd1 100644 --- a/versioned_docs/version-v1.0/platform-engineers/cue/component.md +++ b/versioned_docs/version-v1.0/platform-engineers/cue/component.md @@ -96,7 +96,7 @@ spec: } ``` -Save above `ComponentDefintion` objects to files and install them to your Kubernetes cluster by `$ kubectl apply -f stateless-def.yaml task-def.yaml` +Save above `ComponentDefinition` objects to files and install them to your Kubernetes cluster by `$ kubectl apply -f stateless-def.yaml task-def.yaml` ## Declare an `Application` @@ -173,7 +173,7 @@ spec: ## CUE `Context` -KubeVela allows you to reference the runtime information of your application via `conext` keyword. +KubeVela allows you to reference the runtime information of your application via `context` keyword. The most widely used context is application name(`context.appName`) component name(`context.name`). diff --git a/versioned_docs/version-v1.0/platform-engineers/cue/cross-namespace-resource.md b/versioned_docs/version-v1.0/platform-engineers/cue/cross-namespace-resource.md index 943b0b7b..21773bb1 100644 --- a/versioned_docs/version-v1.0/platform-engineers/cue/cross-namespace-resource.md +++ b/versioned_docs/version-v1.0/platform-engineers/cue/cross-namespace-resource.md @@ -7,7 +7,7 @@ In this section, we will introduce how to use cue template create resources in d By default, the `metadata.namespace` of K8s resource in CUE template is automatically filled with the same namespace of the application. If you want to create K8s resources running in a specific namespace witch is different with the application, you can set the `metadata.namespace` field. -KubeVela will create the resources in the specified namespace, and create a resourceTracker object as owener of those resources. +KubeVela will create the resources in the specified namespace, and create a resourceTracker object as owner of those resources. ## Usage diff --git a/versioned_docs/version-v1.0/platform-engineers/cue/status.md b/versioned_docs/version-v1.0/platform-engineers/cue/status.md index 84063fec..7b09b22c 100644 --- a/versioned_docs/version-v1.0/platform-engineers/cue/status.md +++ b/versioned_docs/version-v1.0/platform-engineers/cue/status.md @@ -27,7 +27,7 @@ context:{ } ``` -Trait will not have the `context.ouput`, other fields are the same. +Trait will not have the `context.output`, other fields are the same. The example of health check likes below: @@ -111,7 +111,7 @@ context:{ } ``` -Trait will not have the `context.ouput`, other fields are the same. +Trait will not have the `context.output`, other fields are the same. Please refer to [this doc](https://github.com/oam-dev/kubevela/blob/master/docs/examples/app-with-status/template.yaml) for the complete example. diff --git a/versioned_docs/version-v1.0/platform-engineers/definition-and-templates.md b/versioned_docs/version-v1.0/platform-engineers/definition-and-templates.md index 7179777f..5453ed67 100644 --- a/versioned_docs/version-v1.0/platform-engineers/definition-and-templates.md +++ b/versioned_docs/version-v1.0/platform-engineers/definition-and-templates.md @@ -83,16 +83,16 @@ Let's explain them in detail. This field defines the constraints that what kinds of workloads this trait is allowed to apply to. - It accepts an array of string as value. -- Each item in the array refers to one or a group of workload types to which this trait is allowded to apply. +- Each item in the array refers to one or a group of workload types to which this trait is allowed to apply. There are four approaches to denote one or a group of workload types. - `ComponentDefinition` name, e.g., `webservice`, `worker` - `ComponentDefinition` definition reference (CRD name), e.g., `deployments.apps` -- Resource group of `ComponentDefinition` definition reference prefixed with `*.`, e.g., `*.apps`, `*.oam.dev`. This means the trait is allowded to apply to any workloads in this group. -- `*` means this trait is allowded to apply to any workloads +- Resource group of `ComponentDefinition` definition reference prefixed with `*.`, e.g., `*.apps`, `*.oam.dev`. This means the trait is allowed to apply to any workloads in this group. +- `*` means this trait is allowed to apply to any workloads -If this field is omitted, it means this trait is allowded to apply to any workload types. +If this field is omitted, it means this trait is allowed to apply to any workload types. KubeVela will raise an error if a trait is applied to a workload which is NOT included in the `appliesToWorkloads`. diff --git a/versioned_docs/version-v1.0/platform-engineers/overview.md b/versioned_docs/version-v1.0/platform-engineers/overview.md index a75b015f..fe914c40 100644 --- a/versioned_docs/version-v1.0/platform-engineers/overview.md +++ b/versioned_docs/version-v1.0/platform-engineers/overview.md @@ -108,7 +108,7 @@ Hence, the `properties` section of `backend` only exposes two parameters to fill Traits (`TraitDefinition` API) are operational features provided by the platform. A trait augments the component instance with operational behaviors such as load balancing policy, network ingress routing, auto-scaling policies, or upgrade strategies, etc. -To attach a trait to component instance, the user will declare `.type` field to reference the specific `TraitDefinition`, and `.properties` field to set property values of the given trait. Similarly, `TraitDefiniton` also allows you to define *template* for operational features. +To attach a trait to component instance, the user will declare `.type` field to reference the specific `TraitDefinition`, and `.properties` field to set property values of the given trait. Similarly, `TraitDefinition` also allows you to define *template* for operational features. In the above example, `type: autoscaler` in `frontend` means the specification (i.e. `properties` section) of this trait will be enforced by a `TraitDefinition` object named `autoscaler` as below: diff --git a/versioned_docs/version-v1.1/developers/config-enviroments.md b/versioned_docs/version-v1.1/developers/config-enviroments.md index 28594bd1..7c658853 100644 --- a/versioned_docs/version-v1.1/developers/config-enviroments.md +++ b/versioned_docs/version-v1.1/developers/config-enviroments.md @@ -88,7 +88,7 @@ Since you now have domain configured globally in deployment environment, you don ```yaml # in demo environment -servcies: +services: express-server: ... diff --git a/versioned_docs/version-v1.1/end-user/pipeline.md b/versioned_docs/version-v1.1/end-user/pipeline.md index 269b0f87..9e307904 100644 --- a/versioned_docs/version-v1.1/end-user/pipeline.md +++ b/versioned_docs/version-v1.1/end-user/pipeline.md @@ -4,5 +4,5 @@ title: Build CI/CD Pipeline TBD, Content Overview: -1. install argo/teckton. +1. install argo/tekton. 2. run the pipeline example: https://github.com/oam-dev/kubevela/tree/master/docs/examples/argo \ No newline at end of file diff --git a/versioned_docs/version-v1.1/install.mdx b/versioned_docs/version-v1.1/install.mdx index a37def90..9defacf8 100644 --- a/versioned_docs/version-v1.1/install.mdx +++ b/versioned_docs/version-v1.1/install.mdx @@ -22,7 +22,7 @@ className="unique-tabs" defaultValue="minikube" values={[ {label: 'Minikube', value: 'minikube'}, -{label: 'KinD', value: 'kind'}, +{label: 'Kind', value: 'kind'}, ]}> diff --git a/versioned_docs/version-v1.1/platform-engineers/cue/basic.md b/versioned_docs/version-v1.1/platform-engineers/cue/basic.md index 6ec9ae89..1de87763 100644 --- a/versioned_docs/version-v1.1/platform-engineers/cue/basic.md +++ b/versioned_docs/version-v1.1/platform-engineers/cue/basic.md @@ -394,7 +394,7 @@ price: 200 feel: "bad" ``` -Another example is to use bool type as prameter. +Another example is to use bool type as parameter. ``` parameter: { diff --git a/versioned_docs/version-v1.1/platform-engineers/cue/component.md b/versioned_docs/version-v1.1/platform-engineers/cue/component.md index 3626c164..d5db7d05 100644 --- a/versioned_docs/version-v1.1/platform-engineers/cue/component.md +++ b/versioned_docs/version-v1.1/platform-engineers/cue/component.md @@ -96,7 +96,7 @@ spec: } ``` -Save above `ComponentDefintion` objects to files and install them to your Kubernetes cluster by `$ kubectl apply -f stateless-def.yaml task-def.yaml` +Save above `ComponentDefinition` objects to files and install them to your Kubernetes cluster by `$ kubectl apply -f stateless-def.yaml task-def.yaml` ## Declare an `Application` @@ -173,7 +173,7 @@ spec: ## CUE `Context` -KubeVela allows you to reference the runtime information of your application via `conext` keyword. +KubeVela allows you to reference the runtime information of your application via `context` keyword. The most widely used context is application name(`context.appName`) component name(`context.name`). diff --git a/versioned_docs/version-v1.1/platform-engineers/cue/cross-namespace-resource.md b/versioned_docs/version-v1.1/platform-engineers/cue/cross-namespace-resource.md index 943b0b7b..21773bb1 100644 --- a/versioned_docs/version-v1.1/platform-engineers/cue/cross-namespace-resource.md +++ b/versioned_docs/version-v1.1/platform-engineers/cue/cross-namespace-resource.md @@ -7,7 +7,7 @@ In this section, we will introduce how to use cue template create resources in d By default, the `metadata.namespace` of K8s resource in CUE template is automatically filled with the same namespace of the application. If you want to create K8s resources running in a specific namespace witch is different with the application, you can set the `metadata.namespace` field. -KubeVela will create the resources in the specified namespace, and create a resourceTracker object as owener of those resources. +KubeVela will create the resources in the specified namespace, and create a resourceTracker object as owner of those resources. ## Usage diff --git a/versioned_docs/version-v1.1/platform-engineers/cue/status.md b/versioned_docs/version-v1.1/platform-engineers/cue/status.md index e82e5934..7b09b22c 100644 --- a/versioned_docs/version-v1.1/platform-engineers/cue/status.md +++ b/versioned_docs/version-v1.1/platform-engineers/cue/status.md @@ -111,7 +111,7 @@ context:{ } ``` -Trait will not have the `context.ouput`, other fields are the same. +Trait will not have the `context.output`, other fields are the same. Please refer to [this doc](https://github.com/oam-dev/kubevela/blob/master/docs/examples/app-with-status/template.yaml) for the complete example. diff --git a/versioned_docs/version-v1.1/platform-engineers/definition-and-templates.md b/versioned_docs/version-v1.1/platform-engineers/definition-and-templates.md index cf0ee168..e9167cd9 100644 --- a/versioned_docs/version-v1.1/platform-engineers/definition-and-templates.md +++ b/versioned_docs/version-v1.1/platform-engineers/definition-and-templates.md @@ -82,15 +82,15 @@ Let's explain them in detail. This field defines the constraints that what kinds of workloads this trait is allowed to apply to. - It accepts an array of string as value. -- Each item in the array refers to one or a group of workload types to which this trait is allowded to apply. +- Each item in the array refers to one or a group of workload types to which this trait is allowed to apply. There are three approaches to denote one or a group of workload types. - `ComponentDefinition` definition reference (CRD name), e.g., `deployments.apps` -- Resource group of `ComponentDefinition` definition reference prefixed with `*.`, e.g., `*.apps`, `*.oam.dev`. This means the trait is allowded to apply to any workloads in this group. -- `*` means this trait is allowded to apply to any workloads +- Resource group of `ComponentDefinition` definition reference prefixed with `*.`, e.g., `*.apps`, `*.oam.dev`. This means the trait is allowed to apply to any workloads in this group. +- `*` means this trait is allowed to apply to any workloads -If this field is omitted, it means this trait is allowded to apply to any workload types. +If this field is omitted, it means this trait is allowed to apply to any workload types. KubeVela will raise an error if a trait is applied to a workload type which is NOT included in the `appliesToWorkloads`.