#134 - Fix some spelling in website -> Getting Started -> v0.2.0 (Hacktoberfest contribution) (#168)

Add a bit of extra words to make complete sentences

website/content/en/docs/Getting Started/v0.2.0/aks.md

@@ -7,7 +7,7 @@ description: >
     Additional configuration for Azure Kubernetes Service
 ---
 
-Azure AKS managed Kubernetes service adds to every pod the following envs:
+Azure AKS managed Kubernetes service adds to every pod the following environment variables:
 
 ```yaml
 - name: KUBERNETES_PORT_443_TCP_ADDR
@@ -20,5 +20,5 @@ Azure AKS managed Kubernetes service adds to every pod the following envs:
   value:
 ```
 
-The operator is aware of it and omits these envs when checking if Jenkins pod envs have been changed. It prevents 
+The operator is aware of it and omits these environment variables when checking if a Jenkins pod environment has been changed. It prevents the 
-restart Jenkins pod over and over again.
+restart of a Jenkins pod over and over again.

website/content/en/docs/Getting Started/v0.2.0/configuration.md

@@ -24,7 +24,7 @@ cicd/
     └── build.jenkins
 ```
 
-**cicd/jobs/build.jenkins** it's a job definition:
+**cicd/jobs/build.jenkins** is a job definition:
 
 ```
 #!/usr/bin/env groovy
@@ -49,7 +49,7 @@ pipelineJob('build-jenkins-operator') {
 }
 ```
 
-**cicd/jobs/build.jenkins** it's an actual Jenkins pipeline:
+**cicd/jobs/build.jenkins** is an actual Jenkins pipeline:
 
 ```
 #!/usr/bin/env groovy
@@ -120,13 +120,13 @@ spec:
     repositoryUrl: https://github.com/jenkinsci/kubernetes-operator.git
 ```
 
-**Jenkins Operator** will automatically discover and configure all seed jobs.
+**Jenkins Operator** will automatically discover and configure all the seed jobs.
 
-You can verify if deploy keys were successfully configured in Jenkins **Credentials** tab.
+You can verify if deploy keys were successfully configured in the Jenkins **Credentials** tab.
 
 ![jenkins](/kubernetes-operator/img/jenkins-credentials.png)
 
-You can verify if your pipelines were successfully configured in Jenkins Seed Job console output.
+You can verify if your pipelines were successfully configured in the Jenkins Seed Job console output.
 
 ![jenkins](/kubernetes-operator/img/jenkins-seed.png)
 
@@ -165,7 +165,7 @@ If key was generated by `ssh-keygen` the public key content is located in <filen
 
 #### Configure SSH authentication
 
-Configure seed job like:
+Configure a seed job like this:
 
 ```
 apiVersion: jenkins.io/v1alpha2
@@ -183,7 +183,7 @@ spec:
     repositoryUrl: git@github.com:jenkinsci/kubernetes-operator.git
 ```
 
-and create Kubernetes Secret(name of secret should be the same from `credentialID` field):
+and create a Kubernetes Secret (name of secret should be the same from `credentialID` field):
 
 ```
 apiVersion: v1
@@ -201,7 +201,7 @@ stringData:
 
 ### Username & password authentication
 
-Configure seed job like:
+Configure the seed job like:
 
 ```
 apiVersion: jenkins.io/v1alpha2
@@ -219,7 +219,7 @@ spec:
     repositoryUrl: https://github.com/jenkinsci/kubernetes-operator.git
 ```
 
-and create Kubernetes Secret(name of secret should be the same from `credentialID` field):
+and create a Kubernetes Secret (name of secret should be the same from `credentialID` field):
 
 ```
 apiVersion: v1
@@ -233,7 +233,7 @@ stringData:
 
 ## HTTP Proxy for downloading plugins
 
-To use forwarding proxy with operator to downloading plugins you need to put environment var to Jenkins CR, for e.g.:
+To use forwarding proxy with an operator to download plugins you need to add the following environment variable to Jenkins CR, for e.g.:
 
 ```yaml
 spec:
@@ -248,7 +248,7 @@ spec:
 In `CURL_OPTIONS` var you can set additional arguments to curl command.
 
 ## Pulling Docker images from private repositories
-To pull Docker Image from private repository you can use `imagePullSecrets`.
+To pull a Docker Image from private repository you can use `imagePullSecrets`.
 
 Please follow the instructions on [creating a secret with a docker config](https://kubernetes.io/docs/concepts/containers/images/?origin_team=T42NTAGHM#creating-a-secret-with-a-docker-config).
 
@@ -262,7 +262,7 @@ kubectl -n <namespace> edit secret <name>
 
 The `.dockerconfigjson` key's value needs to be replaced with a modified version.
 
-After modifications it needs to be encoded as Base64 value before setting the `.dockerconfigjson` key:q.
+After modifications, it needs to be encoded as a Base64 value before setting the `.dockerconfigjson` key:q.
 
 Example config file to modify and use:
 ```

website/content/en/docs/Getting Started/v0.2.0/configure-backup-and-restore.md

@@ -7,13 +7,13 @@ description: >
   Prevent loss of job history
 ---
 
-Backup and restore is done by container sidecar.
+Backup and restore is done by a container sidecar.
 
 ### PVC
 
 #### Create PVC
 
-Save to file pvc.yaml:
+Save to the file named pvc.yaml:
 ```yaml
 apiVersion: v1
 kind: PersistentVolumeClaim
@@ -28,7 +28,7 @@ spec:
       storage: 500Gi
 ```
 
-Run command:
+Run the following command:
 ```bash
 $ kubectl -n <namespace> create -f pvc.yaml
 ```
@@ -49,7 +49,7 @@ spec:
     containers:
     - name: jenkins-master
       image: jenkins/jenkins:lts
-    - name: backup # container responsible for backup and restore
+    - name: backup # container responsible for the backup and restore
       env:
       - name: BACKUP_DIR
         value: /backup
@@ -75,7 +75,7 @@ spec:
         command:
         - /home/user/bin/backup.sh # this command is invoked on "backup" container to make backup, for example /home/user/bin/backup.sh <backup_number>, <backup_number> is passed by operator
     interval: 30 # how often make backup in seconds
-    makeBackupBeforePodDeletion: true # make backup before pod deletion
+    makeBackupBeforePodDeletion: true # make a backup before pod deletion
   restore:
     containerName: backup # container name is responsible for restore backup
     action:

website/content/en/docs/Getting Started/v0.2.0/customization.md

@@ -183,4 +183,4 @@ spec:
 
 You can change their versions.
 
-Then the **Jenkins Operator** will automatically install plugins after the Jenkins master pod restarts.
+The **Jenkins Operator** will then automatically install plugins after the Jenkins master pod restarts.

website/content/en/docs/Getting Started/v0.2.0/deploy-jenkins.md

@@ -56,31 +56,31 @@ spec:
     repositoryUrl: https://github.com/jenkinsci/kubernetes-operator.git
 ```
 
-Deploy Jenkins to K8s:
+Deploy a Jenkins to K8s:
 
 ```bash
 kubectl create -f jenkins_instance.yaml
 ```
-Watch Jenkins instance being created:
+Watch the Jenkins instance being created:
 
 ```bash
 kubectl get pods -w
 ```
 
-Get Jenkins credentials:
+Get the Jenkins credentials:
 
 ```bash
 kubectl get secret jenkins-operator-credentials-<cr_name> -o 'jsonpath={.data.user}' | base64 -d
 kubectl get secret jenkins-operator-credentials-<cr_name> -o 'jsonpath={.data.password}' | base64 -d
 ```
 
-Connect to Jenkins (minikube):
+Connect to the Jenkins instance (minikube):
 
 ```bash
 minikube service jenkins-operator-http-<cr_name> --url
 ```
 
-Connect to Jenkins (actual Kubernetes cluster):
+Connect to the Jenkins instance (actual Kubernetes cluster):
 
 ```bash
 kubectl port-forward jenkins-<cr_name> 8080:8080

website/content/en/docs/Getting Started/v0.2.0/diagnostics.md

@@ -35,7 +35,7 @@ kubectl logs deployment/jenkins-operator
 
 ## Troubleshooting
 
-Delete Jenkins master pod and wait for the new one to come up:
+Delete the Jenkins master pod and wait for the new one to come up:
 
 ```bash
 kubectl delete pod jenkins-<cr_name>

website/content/en/docs/Getting Started/v0.2.0/migration.md

@@ -8,13 +8,13 @@ description: >
 ---
 
 ### Added seed job agent
-Now seed jobs are not built by master executors, but by dedicated agent deployed into Kubernetes. We disabled master executors for security reasons.
+Seed jobs are not built by master executors, but by dedicated agents deployed into Kubernetes. We disabled master executors for security reasons.
 
 ### Apply Jenkins configuration via Groovy scripts instead of Jenkins jobs
-We have removed hardcoded configuration by **Jenkins** jobs. 
+We have removed the hardcoded configuration by **Jenkins** jobs. 
 
 In `v0.1.1` **Jenkins Operator** configuration was stored in `jenkins-operator-user-configuration-<cr_name>`
-If you want to use `v0.2.0` or newer you must simply write refer to old ConfigMap by modifying CR, for example:
+If you want to use `v0.2.0` or newer you must simply write refererences to old ConfigMap by modifying CR, for example:
 
 ```yaml
 apiVersion: jenkins.io/v1alpha2
@@ -32,8 +32,8 @@ spec:
 
 **Jenkins** configuration jobs (*Configure Seed Jobs*, *jenkins-operator-base-configuration*, *jenkins-operator-user-configuration*) have been removed from **Jenkins**.
 
-In `v0.1.1` you can see if configuration failed or successfully updated in **Jenkins** UI (job build logs).
+In `v0.1.1` you can see if the configuration failed or successfully updated in **Jenkins** UI (job build logs).
-Now, when Jenkins configuration jobs are removed, you must use this command to see if configuration was failed.
+When Jenkins configuration jobs are removed, you must use the following command to see if configuration was failed.
 ```bash
 $ kubectl -n logs deployment/jenkins-operator
 ```

website/content/en/docs/Getting Started/v0.2.0/scheme.md

@@ -19,7 +19,7 @@ This document contains API scheme for `jenkins-operator` manifest
 </ul>
 <h2 id="jenkins.io">jenkins.io</h2>
 <p>
-<p>Package v1alpha2 contains API Schema definitions for the jenkins.io v1alpha2 API group</p>
+<p>Package v1alpha2 contains the API Schema definitions for the jenkins.io v1alpha2 API group</p>
 </p>
 Resource Types:
 <ul><li>
@@ -108,7 +108,7 @@ Every single change here requires a pod restart.</p>
 </td>
 <td>
 <em>(Optional)</em>
-<p>SeedJobs defines list of Jenkins Seed Job configurations
+<p>SeedJobs defines a list of Jenkins Seed Job configurations
 More info: <a href="https://github.com/jenkinsci/kubernetes-operator/blob/master/docs/getting-started.md#configure-seed-jobs-and-pipelines">https://github.com/jenkinsci/kubernetes-operator/blob/master/docs/getting-started.md#configure-seed-jobs-and-pipelines</a></p>
 </td>
 </tr>
@@ -123,7 +123,7 @@ Service
 </td>
 <td>
 <em>(Optional)</em>
-<p>Service is Kubernetes service of Jenkins master HTTP pod
+<p>Service is the Kubernetes service of the Jenkins master HTTP pod
 Defaults to :
 port: 8080
 type: ClusterIP</p>
@@ -140,7 +140,7 @@ Service
 </td>
 <td>
 <em>(Optional)</em>
-<p>Service is Kubernetes service of Jenkins slave pods
+<p>Service is the Kubernetes service of the Jenkins slave pods
 Defaults to :
 port: 50000
 type: ClusterIP</p>
@@ -157,7 +157,7 @@ Backup
 </td>
 <td>
 <em>(Optional)</em>
-<p>Backup defines configuration of Jenkins backup
+<p>Backup defines the configuration of a Jenkins backup
 More info: <a href="https://github.com/jenkinsci/kubernetes-operator/blob/master/docs/getting-started.md#configure-backup-and-restore">https://github.com/jenkinsci/kubernetes-operator/blob/master/docs/getting-started.md#configure-backup-and-restore</a></p>
 </td>
 </tr>
@@ -172,7 +172,7 @@ Restore
 </td>
 <td>
 <em>(Optional)</em>
-<p>Backup defines configuration of Jenkins backup restore
+<p>Backup defines the configuration of a Jenkins backup restore
 More info: <a href="https://github.com/jenkinsci/kubernetes-operator/blob/master/docs/getting-started.md#configure-backup-and-restore">https://github.com/jenkinsci/kubernetes-operator/blob/master/docs/getting-started.md#configure-backup-and-restore</a></p>
 </td>
 </tr>
@@ -187,7 +187,7 @@ GroovyScripts
 </td>
 <td>
 <em>(Optional)</em>
-<p>GroovyScripts defines configuration of Jenkins customization via groovy scripts</p>
+<p>GroovyScripts defines the configuration of Jenkins customization via groovy scripts</p>
 </td>
 </tr>
 <tr>
@@ -201,7 +201,7 @@ ConfigurationAsCode
 </td>
 <td>
 <em>(Optional)</em>
-<p>ConfigurationAsCode defines configuration of Jenkins customization via Configuration as Code Jenkins plugin</p>
+<p>ConfigurationAsCode defines the configuration of Jenkins customization via the Configuration as Code Jenkins plugin</p>
 </td>
 </tr>
 </table>
@@ -292,7 +292,7 @@ string
 <a href="#github.com%2fjenkinsci%2fkubernetes-operator%2fpkg%2fapis%2fjenkins%2fv1alpha2.JenkinsSpec">JenkinsSpec</a>)
 </p>
 <p>
-<p>Backup defines configuration of Jenkins backup</p>
+<p>Backup defines the configuration of a Jenkins backup</p>
 </p>
 <table>
 <thead>
@@ -323,7 +323,7 @@ Handler
 </em>
 </td>
 <td>
-<p>Action defines action which performs backup in backup container sidecar</p>
+<p>Action defines the action which performs the backup in the backup container sidecar</p>
 </td>
 </tr>
 <tr>
@@ -334,7 +334,7 @@ uint64
 </em>
 </td>
 <td>
-<p>Interval tells how often make backup in seconds
+<p>Interval tells you how often the backup is made in seconds
 Defaults to 30.</p>
 </td>
 </tr>
@@ -346,7 +346,7 @@ bool
 </em>
 </td>
 <td>
-<p>MakeBackupBeforePodDeletion tells operator to make backup before Jenkins master pod deletion</p>
+<p>MakeBackupBeforePodDeletion tells the operator to make a backup before Jenkins master pod deletion</p>
 </td>
 </tr>
 </tbody>
@@ -358,7 +358,7 @@ bool
 <a href="#github.com%2fjenkinsci%2fkubernetes-operator%2fpkg%2fapis%2fjenkins%2fv1alpha2.Customization">Customization</a>)
 </p>
 <p>
-<p>ConfigMapRef is reference to Kubernetes ConfigMap</p>
+<p>ConfigMapRef is the reference to Kubernetes ConfigMap</p>
 </p>
 <table>
 <thead>
@@ -387,7 +387,7 @@ string
 <a href="#github.com%2fjenkinsci%2fkubernetes-operator%2fpkg%2fapis%2fjenkins%2fv1alpha2.JenkinsSpec">JenkinsSpec</a>)
 </p>
 <p>
-<p>ConfigurationAsCode defines configuration of Jenkins customization via Configuration as Code Jenkins plugin</p>
+<p>ConfigurationAsCode defines configuration of Jenkins customization via the Configuration as Code Jenkins plugin</p>
 </p>
 <table>
 <thead>
@@ -418,7 +418,7 @@ Customization
 <a href="#github.com%2fjenkinsci%2fkubernetes-operator%2fpkg%2fapis%2fjenkins%2fv1alpha2.JenkinsMaster">JenkinsMaster</a>)
 </p>
 <p>
-<p>Container defines Kubernetes container attributes</p>
+<p>Container defines the Kubernetes container attributes</p>
 </p>
 <table>
 <thead>
@@ -773,7 +773,7 @@ Kubernetes core/v1.ExecAction
 <a href="#github.com%2fjenkinsci%2fkubernetes-operator%2fpkg%2fapis%2fjenkins%2fv1alpha2.SeedJob">SeedJob</a>)
 </p>
 <p>
-<p>JenkinsCredentialType defines type of Jenkins credential used to seed job mechanism</p>
+<p>JenkinsCredentialType defines the type of Jenkins credential used in the seed job mechanism</p>
 </p>
 <h3 id="github.com/jenkinsci/kubernetes-operator/pkg/apis/jenkins/v1alpha2.JenkinsMaster">JenkinsMaster
 </h3>
@@ -1233,7 +1233,7 @@ string
 </td>
 <td>
 <em>(Optional)</em>
-<p>UserAndPasswordHash is a SHA256 hash made from user and password</p>
+<p>UserAndPasswordHash is a SHA256 hash made from the username and password</p>
 </td>
 </tr>
 <tr>
@@ -1245,7 +1245,7 @@ string
 </td>
 <td>
 <em>(Optional)</em>
-<p>CreatedSeedJobs contains list of seed job id already created in Jenkins</p>
+<p>CreatedSeedJobs contains list of seed job ids already created in Jenkins</p>
 </td>
 </tr>
 <tr>
@@ -1679,7 +1679,7 @@ string
 </em>
 </td>
 <td>
-<p>Targets is the repository path where are seed job definitions</p>
+<p>Targets is the repository path where the seed job definitions are</p>
 </td>
 </tr>
 <tr>
@@ -1690,7 +1690,7 @@ string
 </em>
 </td>
 <td>
-<p>RepositoryBranch is the repository branch where are seed job definitions</p>
+<p>RepositoryBranch is the repository branch where the seed job definitions are</p>
 </td>
 </tr>
 <tr>
@@ -1887,7 +1887,7 @@ int32
 </em>
 </td>
 <td>
-<p>The port that are exposed by this service.
+<p>The port that is exposed by this service.
 More info: <a href="https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies">https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies</a></p>
 </td>
 </tr>
@@ -1902,7 +1902,7 @@ int32
 <em>(Optional)</em>
 <p>The port on each node on which this service is exposed when type=NodePort or LoadBalancer.
 Usually assigned by the system. If specified, it will be allocated to the service
-if unused or else creation of the service will fail.
+if unused, or else creation of the service will fail.
 Default is to auto-allocate a port if the ServiceType of this Service requires one.
 More info: <a href="https://kubernetes.io/docs/concepts/services-networking/service/#type-nodeport">https://kubernetes.io/docs/concepts/services-networking/service/#type-nodeport</a></p>
 </td>
@@ -1917,7 +1917,7 @@ More info: <a href="https://kubernetes.io/docs/concepts/services-networking/serv
 <td>
 <em>(Optional)</em>
 <p>If specified and supported by the platform, this will restrict traffic through the cloud-provider
-load-balancer will be restricted to the specified client IPs. This field will be ignored if the
+the load-balancer will be restricted to the specified client IPs. This field will be ignored if the
 cloud-provider does not support the feature.&rdquo;
 More info: <a href="https://kubernetes.io/docs/tasks/access-application-cluster/configure-cloud-provider-firewall/">https://kubernetes.io/docs/tasks/access-application-cluster/configure-cloud-provider-firewall/</a></p>
 </td>