Skip to content

Commit cb01a54

Browse files
committed
docs: fix grammar and spelling errors in v1 documentation
- Fix spelling: explaination → explanation - Fix spelling: configuaration → configuration - Fix grammar: that files → those files - Fix grammar: the a piped → a piped - Fix grammar: how install → how to install - Fix grammar: Please checkout → Please check out - Fix phrase: community built → community-built Signed-off-by: ansita20 <ansitasingh20@gmail.com>
1 parent 3d7ec14 commit cb01a54

File tree

4 files changed

+11
-11
lines changed

4 files changed

+11
-11
lines changed

docs/content/en/docs-v1.0.x/installation/install-piped/installing-on-kubernetes.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: "Installing on a Kubernetes cluster"
33
linkTitle: "Installing on a Kubernetes cluster"
44
weight: 1
55
description: >
6-
This page describes how install Piped on a Kubernetes cluster.
6+
This page describes how to install Piped on a Kubernetes cluster.
77
---
88

99
## Prerequisites
@@ -16,7 +16,7 @@ description: >
1616
### SSH Key for Git Repositories
1717

1818
- If your Git repositories are private, `piped` requires a private SSH key to access those repositories.
19-
- Please checkout [this documentation](https://help.github.com/en/github/authenticating-to-github/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent) for how to generate a new SSH key pair. Then add the public key to your repositories. (If you are using GitHub, you can add it to Deploy Keys at the repository's Settings page.)
19+
- Please check out [this documentation](https://help.github.com/en/github/authenticating-to-github/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent) for how to generate a new SSH key pair. Then add the public key to your repositories. (If you are using GitHub, you can add it to Deploy Keys at the repository's Settings page.)
2020

2121
If your Git repositories are private, `piped` needs an SSH key to access them.
2222

@@ -27,11 +27,11 @@ If your Git repositories are private, `piped` needs an SSH key to access them.
2727
2828
## Installation
2929

30-
### Preparing the `Piped` configuaration file
30+
### Preparing the `Piped` configuration file
3131

3232
Plugins are external binaries that have to be referenced in the piped configuration file. There are no plugins set by default.
3333

34-
An example of the a piped V1 configuration file using the Kubernetes plugin:
34+
An example of a piped V1 configuration file using the Kubernetes plugin:
3535

3636
```yaml
3737
apiVersion: pipecd.dev/v1beta1
@@ -52,7 +52,7 @@ spec:
5252
>**Note:**
5353
>`Piped`'s plugins are versioned independently from PipeCD. See the [latest releases](https://github.com/pipe-cd/pipecd/releases) for more information.
5454
>
55-
>We now also have a repository for community built plugins. See the [Community plugins repository on GitHub](https://github.com/pipe-cd/community-plugins) to know more.
55+
>We now also have a repository for community-built plugins. See the [Community plugins repository on GitHub](https://github.com/pipe-cd/community-plugins) to know more.
5656

5757
## In the cluster-wide mode
5858

docs/content/en/docs-v1.0.x/installation/install-piped/installing-on-single-machine.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ description: >
1717
### SSH Key for Git Repositories
1818

1919
- If your Git repositories are private, `piped` requires a private SSH key to access those repositories.
20-
- Please checkout [this documentation](https://help.github.com/en/github/authenticating-to-github/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent) for how to generate a new SSH key pair. Then add the public key to your repositories. (If you are using GitHub, you can add it to Deploy Keys at the repository's Settings page.)
20+
- Please check out [this documentation](https://help.github.com/en/github/authenticating-to-github/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent) for how to generate a new SSH key pair. Then add the public key to your repositories. (If you are using GitHub, you can add it to Deploy Keys at the repository's Settings page.)
2121

2222
If your Git repositories are private, `piped` needs an SSH key to access them.
2323

@@ -32,11 +32,11 @@ Download the latest `piped` V1. See the [latest releases](https://github.com/pip
3232

3333
## Installation
3434

35-
### Preparing the `Piped` configuaration file
35+
### Preparing the `Piped` configuration file
3636

3737
Plugins are external binaries that have to be referenced in the piped configuration file. There are no plugins set by default.
3838

39-
An example of the a piped V1 configuration file using the [Example-stage plugin](https://github.com/pipe-cd/community-plugins/tree/main/plugins/example-stage):
39+
An example of a piped V1 configuration file using the [Example-stage plugin](https://github.com/pipe-cd/community-plugins/tree/main/plugins/example-stage):
4040

4141
```yaml
4242
apiVersion: pipecd.dev/v1beta1
@@ -59,7 +59,7 @@ See [ConfigurationReference](../../../user-guide/managing-piped/configuration-re
5959
>**Note:**
6060
>`Piped`'s plugins are versioned independently from PipeCD. Official plugins are maintained and monitored by the PipeCD Maintainers. See the [latest releases](https://github.com/pipe-cd/pipecd/releases) for more information.
6161
>
62-
>We now also have a repository for community built plugins. See the [Community plugins repository on GitHub](https://github.com/pipe-cd/community-plugins) to know more.
62+
>We now also have a repository for community-built plugins. See the [Community plugins repository on GitHub](https://github.com/pipe-cd/community-plugins) to know more.
6363

6464
## Run the `piped`
6565

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ description: >
66
Overview about PipeCD.
77
---
88

9-
![PipeCD explaination](/images/pipecd-explanation.png)
9+
![PipeCD explanation](/images/pipecd-explanation.png)
1010
<p style="text-align: center;">
1111
PipeCD - a GitOps style continuous delivery solution
1212
</p>

docs/content/en/docs-v1.0.x/user-guide/managing-application/event-watcher.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ Therefore, you mainly need to:
3535
#### Use the `.pipe/` directory
3636

3737
Prepare EventWatcher configuration files under the `.pipe/` directory at the root of your Git repository.
38-
In that files, you define which values in which files should be updated when the Piped found out a new Event.
38+
In those files, you define which values in which files should be updated when the Piped found out a new Event.
3939

4040
For instance, suppose you want to update the Kubernetes manifest defined in `helloworld/deployment.yaml` when an Event with the name `helloworld-image-update` occurs:
4141

0 commit comments

Comments
 (0)