Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fixed typo / grammer in faq and quick start pages #1322

Merged
merged 1 commit into from
Apr 17, 2024
+14 −14
Merged

fixed typo / grammer in faq and quick start pages #1322

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/developers/references/devex/faq.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@ https://github.com/kubevela/kubevela/issues/1662

Refer to the [comparison details](https://kubevela.io/docs/#kubevela-vs-other-software).

### Do yo support Crossplane? What's the difference between terraform and Corssplane in KubeVela?
### Do you support Crossplane? What's the difference between terraform and Crossplane in KubeVela?

KubeVela natively support Crossplane as they're already CRDs, while terraform was not a CRD controller, so the KubeVela community author a [terraform controller](https://github.com/kubevela/terraform-controller) for integration. You can choose any of them as you wish.
KubeVela natively supports Crossplane as they're already CRDs, while terraform was not a CRD controller, so the KubeVela community authored a [terraform controller](https://github.com/kubevela/terraform-controller) for integration. You can choose any of them as you wish.


### What's the relationship between KubeVela and OAM? What will KubeVela mainly focus?
Expand Down Expand Up @@ -94,6 +94,6 @@ There are several common possible reasons for slow multi-cluster requests.

1. Your managed cluster is far from your hub cluster. For example, one in Beijing and another one in London. This is hard to speed up. You might need to find methods to build stable network connections between them. KubeVela currently cannot help it.

2. Your cluster-gateway uses version <= 1.3.2. There is a rate limiter in cluster-gateway in old versions. Therefore, if you have lots of multi-cluster requests, they will be blocked at cluster-gateway. Upgrade cluster-gateway to newer version could solve it.
2. Your cluster-gateway uses version <= 1.3.2. There is a rate limiter in cluster-gateway in old versions. Therefore, if you have lots of multi-cluster requests, they will be blocked at cluster-gateway. Upgrading cluster-gateway to a newer version could solve it.

3. Your cluster-gateway hits the resource limits. For example, the CPU/Memory usage is high. This could happen if you have lots of clusters. You can raise the resource configuration for the cluster-gateway.
8 changes: 4 additions & 4 deletions docs/quick-start.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ environment prod with namespace prod created
```
</details>

* Starting deploy the application
* Starting to deploy the application

```
vela up -f https://kubevela.net/example/applications/first-app.yaml
Expand All @@ -103,7 +103,7 @@ Application prod/first-vela-app applied.
```
</details>

* View the process and status of the application deploy
* View the process and status of the application deployment

```bash
vela status first-vela-app
Expand Down Expand Up @@ -135,7 +135,7 @@ Services:
```
</details>

The application will become a `workflowSuspending` status, it means the workflow has finished the first two steps and waiting for manual approval as the step specified.
The application status will change to `workflowSuspending`, means the workflow has finished the first two steps and waiting for manual approval as per the step specified.

* Access the application

Expand Down Expand Up @@ -216,7 +216,7 @@ Great! You have finished deploying your first KubeVela application, you can also

## Manage application with UI Console

After finished [the installation of VelaUX](./install.mdx#2-install-velaux), you can view and manage the application created.
After finishing [the installation of VelaUX](./install.mdx#2-install-velaux), you can view and manage the application created.

* Port forward the UI if you don't have endpoint for access:
```
Expand Down
6 changes: 3 additions & 3 deletions versioned_docs/version-v1.9/developers/references/devex/faq.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@ https://github.com/kubevela/kubevela/issues/1662

Refer to the [comparison details](https://kubevela.io/docs/#kubevela-vs-other-software).

### Do yo support Crossplane? What's the difference between terraform and Corssplane in KubeVela?
### Do you support Crossplane? What's the difference between terraform and Crossplane in KubeVela?

KubeVela natively support Crossplane as they're already CRDs, while terraform was not a CRD controller, so the KubeVela community author a [terraform controller](https://github.com/kubevela/terraform-controller) for integration. You can choose any of them as you wish.
KubeVela natively supports Crossplane as they're already CRDs, while terraform was not a CRD controller, so the KubeVela community authored a [terraform controller](https://github.com/kubevela/terraform-controller) for integration. You can choose any of them as you wish.


### What's the relationship between KubeVela and OAM? What will KubeVela mainly focus?
Expand Down Expand Up @@ -94,6 +94,6 @@ There are several common possible reasons for slow multi-cluster requests.

1. Your managed cluster is far from your hub cluster. For example, one in Beijing and another one in London. This is hard to speed up. You might need to find methods to build stable network connections between them. KubeVela currently cannot help it.

2. Your cluster-gateway uses version <= 1.3.2. There is a rate limiter in cluster-gateway in old versions. Therefore, if you have lots of multi-cluster requests, they will be blocked at cluster-gateway. Upgrade cluster-gateway to newer version could solve it.
2. Your cluster-gateway uses version <= 1.3.2. There is a rate limiter in cluster-gateway in old versions. Therefore, if you have lots of multi-cluster requests, they will be blocked at cluster-gateway. Upgrading cluster-gateway to a newer version could solve it.

3. Your cluster-gateway hits the resource limits. For example, the CPU/Memory usage is high. This could happen if you have lots of clusters. You can raise the resource configuration for the cluster-gateway.
8 changes: 4 additions & 4 deletions versioned_docs/version-v1.9/quick-start.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ environment prod with namespace prod created
```
</details>

* Starting deploy the application
* Starting to deploy the application

```
vela up -f https://kubevela.net/example/applications/first-app.yaml
Expand All @@ -103,7 +103,7 @@ Application prod/first-vela-app applied.
```
</details>

* View the process and status of the application deploy
* View the process and status of the application deployment

```bash
vela status first-vela-app
Expand Down Expand Up @@ -135,7 +135,7 @@ Services:
```
</details>

The application will become a `workflowSuspending` status, it means the workflow has finished the first two steps and waiting for manual approval as the step specified.
The application status will change to `workflowSuspending`, means the workflow has finished the first two steps and waiting for manual approval as per the step specified.

* Access the application

Expand Down Expand Up @@ -216,7 +216,7 @@ Great! You have finished deploying your first KubeVela application, you can also

## Manage application with UI Console

After finished [the installation of VelaUX](./install.mdx#2-install-velaux), you can view and manage the application created.
After finishing [the installation of VelaUX](./install.mdx#2-install-velaux), you can view and manage the application created.

* Port forward the UI if you don't have endpoint for access:
```
Expand Down
Loading