Skip to content

Commit fd80621

Browse files
authored
Docs: v1 fix grammar and inconsistencies (#6463)
* fix grammer and inconsistencies Signed-off-by: rahulshendre <rahulshendre789@gmail.com> * wording change Signed-off-by: rahulshendre <rahulshendre789@gmail.com> --------- Signed-off-by: rahulshendre <rahulshendre789@gmail.com> Signed-off-by: Rahul Shendre <144231863+rahulshendre@users.noreply.github.com>
1 parent 1c045f7 commit fd80621

File tree

27 files changed

+190
-190
lines changed

27 files changed

+190
-190
lines changed

docs/content/en/docs-v1.0.x/contribution-guidelines/contributing-plugins.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,15 @@ description: >
66
Learn how to create PipeCD plugins.
77
---
88

9-
PipeCD's plugin architecture allows anyone to extend piped's capabilities by creating custom plugins. This guide explains how to develop and contribute plugins.
9+
PipeCD's plugin architecture allows anyone to extend `piped`'s capabilities by creating custom plugins. This guide explains how to develop and contribute plugins.
1010

1111
## Understanding the plugin architecture
1212

13-
In PipeCD v1, plugins are the actors that execute deployments on behalf of piped. Instead of piped directly deploying to platforms, plugins handle platform-specific logic while piped's core controls deployment flows.
13+
In PipeCD v1, plugins are the actors that execute deployments on behalf of `piped`. Instead of `piped` directly deploying to platforms, plugins handle platform-specific logic while `piped`'s core controls deployment flows.
1414

1515
**Key concepts:**
1616

17-
- **Plugins** run as gRPC servers, launched and managed by piped
17+
- **Plugins** run as gRPC servers, launched and managed by `piped`
1818
- **Deploy targets** define where a plugin deploys (e.g., a Kubernetes cluster)
1919
- Plugins can be **official** (maintained by PipeCD team) or **community-contributed**
2020

@@ -81,7 +81,7 @@ your-plugin/
8181

8282
### Plugin configuration
8383

84-
Plugins are configured in the piped config. See the [piped installation guide](/docs-v1.0.x/installation/install-piped/) for configuration examples:
84+
Plugins are configured in the `piped` config. See the [`piped` installation guide](/docs-v1.0.x/installation/install-piped/) for configuration examples:
8585

8686
```yaml
8787
apiVersion: pipecd.dev/v1beta1

docs/content/en/docs-v1.0.x/faq/_index.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,13 @@ description: >
88

99
We have answered some of the most frequently asked questions below. If you have any other questions, please feel free to create the issue in the [pipe-cd/pipecd](https://github.com/pipe-cd/pipecd/issues/new/choose) repository or contact us on [Cloud Native Slack](https://slack.cncf.io) (channel [#pipecd](https://app.slack.com/client/T08PSQ7BQ/C01B27F9T0X)).
1010

11-
### 1. What is PipeCD V1? How is it different from the PipeCD Versions so far?
11+
### 1. What is PipeCD v1? How is it different from the PipeCD versions so far?
1212

13-
PipeCD V1 introduces a plugin-based architecture where each application deployment is managed by a 'plugin', created specifically for that application. This replaces the concept of Platform Providers from earlier versions of PipeCD. This change makes PipeCD versatile, allowing users to create custom plugins to deploy the application of their choice.
13+
PipeCD v1 introduces a plugin-based architecture where each application deployment is managed by a 'plugin', created specifically for that application. This replaces the concept of Platform Providers from earlier versions of PipeCD. This change makes PipeCD versatile, allowing users to create custom plugins to deploy the application of their choice.
1414

15-
### 2. What kind of applications will be supported in PipeCD V1?
15+
### 2. What kind of applications will be supported in PipeCD v1?
1616

17-
Since PipeCD V1 introduces a plugin architecture, you can now deploy any application using plugins.
17+
Since PipeCD v1 introduces a plugin architecture, you can now deploy any application using plugins.
1818

1919
Check out the latest releases on GitHub for the list of available plugins. Additionally, we also have a Community Plugins Repository for plugins made by the PipeCD community. As of now, the official plugins maintained by the PipeCD Maintainers are Kubernetes, Terraform, Analysis, ScriptRun, Wait, and WaitApproval.
2020

@@ -30,38 +30,38 @@ Yes, you can use PipeCD for both mesh (Istio, SMI) applications and non-mesh app
3030

3131
### 5. What are the differences between PipeCD and FluxCD?
3232

33-
- Apart from Kubernetes applications, PipeCD also provides a unified interface for other cloud services (GCP Cloud Run, AWS ECS, AWS Lambda and more). Starting PipeCD V1, users can use PipeCD with even more applications by creating custom plugins for their deployments.
33+
- Apart from Kubernetes applications, PipeCD also provides a unified interface for other cloud services (GCP Cloud Run, AWS ECS, AWS Lambda and more). Starting PipeCD v1, users can use PipeCD with even more applications by creating custom plugins for their deployments.
3434
Here are some standout features of PipeCD when compared to Flux:
3535

3636
- One tool for both GitOps sync and progressive deployment
3737
- Supports multiple Git repositories
3838
- Has web UI for better visibility
3939
- Log viewer for each deployment
40-
- Visualization of application component/state in realtime
41-
- Show configuration drift in realtime
40+
- Visualization of application component/state in real-time
41+
- Show configuration drift in real-time
4242
- Also supports Canary and BlueGreen for non-mesh applications
4343
- Has built-in secrets management
4444
- Shows the delivery performance insights
4545

4646
### 6. What are the differences between PipeCD and ArgoCD?
4747

48-
- Apart from Kubernetes applications, PipeCD also provides a unified interface for other cloud services (GCP Cloud Run, AWS ECS, AWS Lambda and more). Starting PipeCD V1, users can use PipeCD with even more applications by creating custom plugins for their deployments.
48+
- Apart from Kubernetes applications, PipeCD also provides a unified interface for other cloud services (GCP Cloud Run, AWS ECS, AWS Lambda and more). Starting PipeCD v1, users can use PipeCD with even more applications by creating custom plugins for their deployments.
4949
Here are some standout features of PipeCD when compared to ArgoCD:
5050

5151
- One tool for both GitOps sync and progressive deployment
5252
- Don't need another CRD or changing the existing manifests for doing Canary/BlueGreen. PipeCD just uses the standard Kubernetes deployment object
5353
- Easier and safer to operate multi-tenancy, multi-cluster for multiple teams (even some teams are running in a private/restricted network)
5454
- Has built-in secrets management
55-
- Shows the delivery performance insights
55+
- Shows the delivery performance insights
5656

57-
### 7. What should I do if I lose my Piped key?
57+
### 7. What should I do if I lose my `piped` key?
5858

59-
You can create a new Piped key. Go to the `Piped` tab at `Settings` page, and click the vertical ellipsis of the Piped that you would like to create the new Piped key. Don't forget deleting the old Key, too.
59+
You can create a new `piped` key. Go to the `piped` tab at `Settings` page, and click the vertical ellipsis of the `piped` that you would like to create the new `piped` key. Don't forget to delete the old key, too.
6060

6161
### 8. What is the strong point if PipeCD is used only for Kubernetes?
6262

6363
- Simple interface, easy to understand no extra CRD required
64-
- Easy to install, upgrade, and manage (both the ControlPlane and the agent Piped)
64+
- Easy to install, upgrade, and manage (both the Control Plane and the agent `piped`)
6565
- Not strict depend on any Kubernetes API, not being part of issues for your Kubernetes cluster versioning upgrade
6666
- Easy to interact with any CI; Plan preview feature gives you an early look at what will be changed in your cluster even before manifests update
6767
- Insights show metrics like lead time, deployment frequency, MTTR, and change failure rate to measure delivery performance
@@ -72,7 +72,7 @@ Yes, PipeCD is fully open source project with APACHE LICENSE, VERSION 2.0
7272

7373
From May 2023, PipeCD joined CNCF as a [Sandbox project](https://www.cncf.io/projects/pipecd/).
7474

75-
### 10. How should I investigate high CPU usage or memory usage in piped, or when OOM occurs?
75+
### 10. How should I investigate high CPU usage or memory usage in `piped`, or when OOM occurs?
7676

77-
If you're noticing high CPU usage, memory usage, or facing OOM issues in Piped, you can use the built-in support for `pprof`, a tool for visualization and analysis of profiling data.
78-
`pprof` can help you identify the parts of your application that are consuming the most resources. For more detailed information and examples of how to use `pprof` in Piped, please see [Using Pprof in Piped](../managing-piped/using-pprof-in-piped).
77+
If you're noticing high CPU usage, memory usage, or facing OOM issues in `piped`, you can use the built-in support for `pprof`, a tool for visualization and analysis of profiling data.
78+
`pprof` can help you identify the parts of your application that are consuming the most resources. For more detailed information and examples of how to use `pprof` in `piped`, please see [Using Pprof in `piped`](../managing-piped/using-pprof-in-piped).

docs/content/en/docs-v1.0.x/installation/_index.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,17 +6,17 @@ description: >
66
Complete guideline for installing and configuring PipeCD on your own.
77
---
88

9-
Before starting to install PipeCD, lets have a look at PipeCDs components, determine your role, and which components you will interact with while installing/using PipeCD. Youre recommended to read about PipeCDs [Control Plane](../concepts/#control-plane) and [Piped](../concepts/#piped) on the concepts page.
9+
Before starting to install PipeCD, let's have a look at PipeCD's components, determine your role, and which components you will interact with while installing/using PipeCD. You're recommended to read about PipeCD's [Control Plane](../concepts/#control-plane) and [`piped`](../concepts/#piped) on the concepts page.
1010

1111
![](/images/architecture-overview-with-roles.png)
1212
<p style="text-align: center;">
1313
PipeCD's components with roles
1414
</p>
1515

16-
Basically, there are two types of users/roles that exist in the PipeCD system, which are:
16+
Basically, there are two types of users/roles that exist in the PipeCD system:
1717

18-
- Developers/Production team: Users who use PipeCD to manage their applications deployments. You will interact with Piped and may or may not need to install Piped by yourself.
18+
- Developers/Production team: Users who use PipeCD to manage their applications' deployments. You will interact with `piped` and may or may not need to install `piped` by yourself.
1919

20-
- Operators/Platform team: Users who operate the PipeCD for other developers can use it. You will interact with the Control Plane and Piped, you will be the one who installs the Control Plane and keeps it up for other Pipeds to connect while managing their applications deployments.
20+
- Operators/Platform team: Users who operate PipeCD for other developers. You will interact with the Control Plane and `piped`, you will be the one who installs the Control Plane and keeps it up for other `piped` instances to connect while managing their applications' deployments.
2121

22-
This section contains the guideline for installing PipeCD's Control Plane and Piped step by step. You can choose what to read based on your roles.
22+
This section contains guidelines for installing PipeCD's Control Plane and `piped` step by step. You can choose what to read based on your roles.

docs/content/en/docs-v1.0.x/installation/install-control-plane/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,4 @@ description: >
66
This page describes how to install a control plane.
77
---
88

9-
Since Control Plane is a centralized component managing deployment data and provides gRPC API, it needs some components fo storing data or credential... and so on. We explain how to deploy Control Plane components.
9+
Since Control Plane is a centralized component managing deployment data and provides gRPC API, it needs some components for storing data or credentials, and so on. We explain how to deploy Control Plane components.

docs/content/en/docs-v1.0.x/installation/install-control-plane/installing-controlplane-on-ECS.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ description: >
66
This page describes how to install control plane on ECS.
77
---
88

9-
Currently, we provide the example of deploying Control Plane to ECS using terraform.
9+
Currently, we provide an example of deploying Control Plane to ECS using Terraform.
1010

11-
Please refer to the blog post :)
11+
Please refer to the blog post:
1212
[PipeCD best practice 02 - control plane on ECS]({{< ref "/blog/control-plane-on-ecs.md" >}} "PipeCD best practice 02 - control plane on ECS").

0 commit comments

Comments
 (0)