From e907dfe0b41f586c0184622e5f7a730ace6b96bc Mon Sep 17 00:00:00 2001 From: Jon Brohauge Date: Thu, 24 Oct 2019 14:47:03 +0200 Subject: [PATCH] #134 - Fix some spelling in website -> Getting Started -> v0.2.0 (Hacktoberfest contribution) (#168) Add a bit of extra words to make complete sentences --- .../en/docs/Getting Started/v0.2.0/aks.md | 6 +-- .../Getting Started/v0.2.0/configuration.md | 24 +++++----- .../v0.2.0/configure-backup-and-restore.md | 10 ++-- .../Getting Started/v0.2.0/customization.md | 2 +- .../Getting Started/v0.2.0/deploy-jenkins.md | 10 ++-- .../Getting Started/v0.2.0/diagnostics.md | 2 +- .../docs/Getting Started/v0.2.0/migration.md | 10 ++-- .../en/docs/Getting Started/v0.2.0/scheme.md | 46 +++++++++---------- 8 files changed, 55 insertions(+), 55 deletions(-) diff --git a/website/content/en/docs/Getting Started/v0.2.0/aks.md b/website/content/en/docs/Getting Started/v0.2.0/aks.md index c118a396..7eab9a40 100644 --- a/website/content/en/docs/Getting Started/v0.2.0/aks.md +++ b/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 -restart Jenkins pod over and over again. \ No newline at end of file +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 of a Jenkins pod over and over again. \ No newline at end of file diff --git a/website/content/en/docs/Getting Started/v0.2.0/configuration.md b/website/content/en/docs/Getting Started/v0.2.0/configuration.md index cb2dee18..9efd1bc5 100644 --- a/website/content/en/docs/Getting Started/v0.2.0/configuration.md +++ b/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 edit secret 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: ``` diff --git a/website/content/en/docs/Getting Started/v0.2.0/configure-backup-and-restore.md b/website/content/en/docs/Getting Started/v0.2.0/configure-backup-and-restore.md index 727a1af4..c8987e0e 100644 --- a/website/content/en/docs/Getting Started/v0.2.0/configure-backup-and-restore.md +++ b/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 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 , 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: diff --git a/website/content/en/docs/Getting Started/v0.2.0/customization.md b/website/content/en/docs/Getting Started/v0.2.0/customization.md index 80382d28..95020574 100644 --- a/website/content/en/docs/Getting Started/v0.2.0/customization.md +++ b/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. diff --git a/website/content/en/docs/Getting Started/v0.2.0/deploy-jenkins.md b/website/content/en/docs/Getting Started/v0.2.0/deploy-jenkins.md index e2644db5..2f212796 100644 --- a/website/content/en/docs/Getting Started/v0.2.0/deploy-jenkins.md +++ b/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- -o 'jsonpath={.data.user}' | base64 -d kubectl get secret jenkins-operator-credentials- -o 'jsonpath={.data.password}' | base64 -d ``` -Connect to Jenkins (minikube): +Connect to the Jenkins instance (minikube): ```bash minikube service jenkins-operator-http- --url ``` -Connect to Jenkins (actual Kubernetes cluster): +Connect to the Jenkins instance (actual Kubernetes cluster): ```bash kubectl port-forward jenkins- 8080:8080 diff --git a/website/content/en/docs/Getting Started/v0.2.0/diagnostics.md b/website/content/en/docs/Getting Started/v0.2.0/diagnostics.md index 8282cae2..1d2ec29f 100644 --- a/website/content/en/docs/Getting Started/v0.2.0/diagnostics.md +++ b/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- diff --git a/website/content/en/docs/Getting Started/v0.2.0/migration.md b/website/content/en/docs/Getting Started/v0.2.0/migration.md index 94e5acb0..2ad78bf0 100644 --- a/website/content/en/docs/Getting Started/v0.2.0/migration.md +++ b/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-` -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). -Now, when Jenkins configuration jobs are removed, you must use this command to see if configuration was failed. +In `v0.1.1` you can see if the configuration failed or successfully updated in **Jenkins** UI (job build logs). +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 ``` \ No newline at end of file diff --git a/website/content/en/docs/Getting Started/v0.2.0/scheme.md b/website/content/en/docs/Getting Started/v0.2.0/scheme.md index c5d6cccc..8eb63f03 100644 --- a/website/content/en/docs/Getting Started/v0.2.0/scheme.md +++ b/website/content/en/docs/Getting Started/v0.2.0/scheme.md @@ -19,7 +19,7 @@ This document contains API scheme for `jenkins-operator` manifest

jenkins.io

-

Package v1alpha2 contains API Schema definitions for the jenkins.io v1alpha2 API group

+

Package v1alpha2 contains the API Schema definitions for the jenkins.io v1alpha2 API group

Resource Types:
  • @@ -108,7 +108,7 @@ Every single change here requires a pod restart.

    (Optional) -

    SeedJobs defines list of Jenkins Seed Job configurations +

    SeedJobs defines a list of Jenkins Seed Job configurations More info: https://github.com/jenkinsci/kubernetes-operator/blob/master/docs/getting-started.md#configure-seed-jobs-and-pipelines

    @@ -123,7 +123,7 @@ Service (Optional) -

    Service is Kubernetes service of Jenkins master HTTP pod +

    Service is the Kubernetes service of the Jenkins master HTTP pod Defaults to : port: 8080 type: ClusterIP

    @@ -140,7 +140,7 @@ Service (Optional) -

    Service is Kubernetes service of Jenkins slave pods +

    Service is the Kubernetes service of the Jenkins slave pods Defaults to : port: 50000 type: ClusterIP

    @@ -157,7 +157,7 @@ Backup (Optional) -

    Backup defines configuration of Jenkins backup +

    Backup defines the configuration of a Jenkins backup More info: https://github.com/jenkinsci/kubernetes-operator/blob/master/docs/getting-started.md#configure-backup-and-restore

    @@ -172,7 +172,7 @@ Restore (Optional) -

    Backup defines configuration of Jenkins backup restore +

    Backup defines the configuration of a Jenkins backup restore More info: https://github.com/jenkinsci/kubernetes-operator/blob/master/docs/getting-started.md#configure-backup-and-restore

    @@ -187,7 +187,7 @@ GroovyScripts (Optional) -

    GroovyScripts defines configuration of Jenkins customization via groovy scripts

    +

    GroovyScripts defines the configuration of Jenkins customization via groovy scripts

    @@ -201,7 +201,7 @@ ConfigurationAsCode (Optional) -

    ConfigurationAsCode defines configuration of Jenkins customization via Configuration as Code Jenkins plugin

    +

    ConfigurationAsCode defines the configuration of Jenkins customization via the Configuration as Code Jenkins plugin

    @@ -292,7 +292,7 @@ string JenkinsSpec)

    -

    Backup defines configuration of Jenkins backup

    +

    Backup defines the configuration of a Jenkins backup

    @@ -323,7 +323,7 @@ Handler @@ -334,7 +334,7 @@ uint64 @@ -346,7 +346,7 @@ bool @@ -358,7 +358,7 @@ bool Customization)

    -

    ConfigMapRef is reference to Kubernetes ConfigMap

    +

    ConfigMapRef is the reference to Kubernetes ConfigMap

    -

    Action defines action which performs backup in backup container sidecar

    +

    Action defines the action which performs the backup in the backup container sidecar
    -

    Interval tells how often make backup in seconds +

    Interval tells you how often the backup is made in seconds Defaults to 30.
    -

    MakeBackupBeforePodDeletion tells operator to make backup before Jenkins master pod deletion

    +

    MakeBackupBeforePodDeletion tells the operator to make a backup before Jenkins master pod deletion
    @@ -387,7 +387,7 @@ string JenkinsSpec)

    -

    ConfigurationAsCode defines configuration of Jenkins customization via Configuration as Code Jenkins plugin

    +

    ConfigurationAsCode defines configuration of Jenkins customization via the Configuration as Code Jenkins plugin

    @@ -418,7 +418,7 @@ Customization JenkinsMaster)

    -

    Container defines Kubernetes container attributes

    +

    Container defines the Kubernetes container attributes

    @@ -773,7 +773,7 @@ Kubernetes core/v1.ExecAction SeedJob)

    -

    JenkinsCredentialType defines type of Jenkins credential used to seed job mechanism

    +

    JenkinsCredentialType defines the type of Jenkins credential used in the seed job mechanism

    JenkinsMaster

    @@ -1233,7 +1233,7 @@ string @@ -1245,7 +1245,7 @@ string @@ -1679,7 +1679,7 @@ string @@ -1690,7 +1690,7 @@ string @@ -1887,7 +1887,7 @@ int32 @@ -1902,7 +1902,7 @@ int32 (Optional)

    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: https://kubernetes.io/docs/concepts/services-networking/service/#type-nodeport

    @@ -1917,7 +1917,7 @@ More info: https://kubernetes.io/docs/tasks/access-application-cluster/configure-cloud-provider-firewall/

    (Optional) -

    UserAndPasswordHash is a SHA256 hash made from user and password

    +

    UserAndPasswordHash is a SHA256 hash made from the username and password
    (Optional) -

    CreatedSeedJobs contains list of seed job id already created in Jenkins

    +

    CreatedSeedJobs contains list of seed job ids already created in Jenkins
    -

    Targets is the repository path where are seed job definitions

    +

    Targets is the repository path where the seed job definitions are
    -

    RepositoryBranch is the repository branch where are seed job definitions

    +

    RepositoryBranch is the repository branch where the seed job definitions are
    -

    The port that are exposed by this service. +

    The port that is exposed by this service. More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies