typos

2022-08-25 16:57:10 -07:00
parent 95e2289e9a
commit f7bc6db35c
7 changed files with 20 additions and 20 deletions
@@ -19,7 +19,7 @@ This lab bootstraps a Valet environment using GitHub Codespaces and enables you
    - Click the `Code` with button down arrow above repository on the repository's landing page.
    - Click the `Codespaces` tab
    - Click `Create codespaces on main` to create the codespace. If you are in another branch then the `main` branch, the codespace will button will have the current branch specified.
-    - Wait a couple minutes, then verify that the codespace starts up. Once it is fully booted up, the termininal should be present.
+    - Wait a couple minutes, then verify that the codespace starts up. Once it is fully booted up, the terminal should be present.
 2. Verify Valet CLI is installed and working. More information on the [GitHub Valet CLI extension](https://github.com/github/gh-valet)
    - Verify Valet CLI is installed and working
    - Run the following command in the Visual Studio Code terminal:
@@ -51,7 +51,7 @@ This lab bootstraps a Valet environment using GitHub Codespaces and enables you
  - username: `admin`
  - password: `password`

-2. Click the `Sign in` button and you should now see your new Jenkins instance with a few pre-populataed pipelines.
+2. Click the `Sign in` button and you should now see your new Jenkins instance with a few pre-populated pipelines.

 ## Labs for Jenkins

@@ -72,7 +72,7 @@ Manually Install the GitHub CLI Valet extension. More information on the [GitHub
 - Run this command to install the GitHub Valet extension
 - `gh extension install github/gh-valet`
 - Verify the result of the install is: `✓ Installed extension github/gh-valet`
- If you get a similiar error to the following, click the link to authorize the token
+- If you get a similar error to the following, click the link to authorize the token
  - Restart Codespace after clicking the link
 - Verify Valet CLI is installed and working by running `gh valet version`

@@ -14,7 +14,7 @@ By the end of this lab you will have performed an audit on the demo Jenkins inst

 ## Prerequisites

-1. Followed [steps](../jenkins/readme.md#valet-labs-for-jenkins) to set up your codespace environment and start your Jenkins instanace.
+1. Followed [steps](../jenkins/readme.md#valet-labs-for-jenkins) to set up your codespace environment and start your Jenkins instance.
 2. Completed the [configure lab](../jenkins/valet-configure-lab.md#configure-valet-to-work-with-jenkins) to configure the Valet CLI.

 ## Perform an audit
@@ -60,7 +60,7 @@ The audit summary starts by giving a summary of the types of pipelines that were

 - It shows that there are a total of 7 pipelines extracted.

- 42% pipelines were successful. This means that Valet knew how to map all the constructs of the Jenkins pipeline to a GitHub Actions equivalent. All of the build pluggins and triggers that are referenced were all successfully converted into a GitHub Actions equivalent.
+- 42% pipelines were successful. This means that Valet knew how to map all the constructs of the Jenkins pipeline to a GitHub Actions equivalent. All of the build plugins and triggers that are referenced were all successfully converted into a GitHub Actions equivalent.

 - 42% pipelines were partially successful. This means that Valet knew how to map all the constructs of the Jenkins pipeline but there may be a plugin that was referenced that Valet wasn't able to automatically map to a Github Actions equivalent.

@@ -68,7 +68,7 @@ The audit summary starts by giving a summary of the types of pipelines that were

 - 0% of these fail altogether. If there were any pipelines that would fall under this category, that would mean that those pipelines were misconfigured or there was an issue with Valet.

-Under the `Job types` section, we can see that the `audit` command is able to support the conversion of project, freestyle (flow-defintion), and multibranch pipelines from Jenkins and convert them to a GitHub Actions workflow. Valet does not support converting [scripted pipelines](https://www.jenkins.io/doc/book/pipeline/syntax/#scripted-pipeline) (e.g. pure Groovy).
+Under the `Job types` section, we can see that the `audit` command is able to support the conversion of project, freestyle (flow-definition), and multibranch pipelines from Jenkins and convert them to a GitHub Actions workflow. Valet does not support converting [scripted pipelines](https://www.jenkins.io/doc/book/pipeline/syntax/#scripted-pipeline) (e.g. pure Groovy).

 #### Example

@@ -79,7 +79,7 @@ Under the `Job types` section, we can see that the `audit` command is able to su
 Under the `Build steps` section we can see a breakdown of the build steps that were used in these pipelines.

 - <b>Supported:</b> 12/16 discrete build steps are considered known by Valet. When Valet encounters a build step of this type, it knows exactly how to map that into a GitHub Actions equivalent.
- <b>Unknown:</b> 3/16 discrete build steps are considered unknown by Valet. When Valet enounters a build step of this type, it does not yet know to map this automatically to a GitHub Action equivalent.
+- <b>Unknown:</b> 3/16 discrete build steps are considered unknown by Valet. When Valet encounters a build step of this type, it does not yet know to map this automatically to a GitHub Action equivalent.
 - <b>Unsupported:</b> 1/16 discrete build steps are considered unsupported by Valet. This could mean one of three things:
    1. The way that plugin was configured for a given job is unsupported.
    2. The plugin itself is fundamentally not supported in GitHub Actions.
@@ -95,7 +95,7 @@ For example, if you are doing things like setting up the allow list of third-par

 ### Trigger, Environment, Other

-Similar to `Build steps`, there are `Trigger`, `Environment`, and a catch all `Other` section that breakdown each of their uses accross the audited pipelines.
+Similar to `Build steps`, there are `Trigger`, `Environment`, and a catch all `Other` section that breakdown each of their uses across the audited pipelines.

 ### Example

@@ -9,7 +9,7 @@ In this lab, you will use the Valet `configure` command to set up the required i

 ## Prerequisites

-1. Followed [steps](../jenkins/readme.md#valet-labs-for-jenkins) to set up your codespace environment and start your Jenkins instanace.
+1. Followed [steps](../jenkins/readme.md#valet-labs-for-jenkins) to set up your codespace environment and start your Jenkins instance.

 ## Configuring Valet

@@ -21,7 +21,7 @@ In this lab, you will use the Valet `configure` command to set up the required i
      - Click the `admin` button located within the top right menu.
      - Click on the `configure` gear located on the left hand panel.
      - Under the `API token` section, click `Add new Token`.
-      - Add a defaualt name to your token, then click `Generate`.
+      - Add a default name to your token, then click `Generate`.
      - Copy the token that was generated and record token for a later step.

      ![configure-result](https://user-images.githubusercontent.com/19557880/184041667-d06cb7f2-a885-474e-b728-7567314aeaf3.png)
@@ -36,7 +36,7 @@ In this lab, you will use the Valet `configure` command to set up the required i
    - Copy the token somewhere safe and temporary.
 3. Run Valet configure commands
   - In the codespace terminal window click back to the `TERMINAL` tab.
-   - Within the terminal, ensure you are in the root dirrectory.
+   - Within the terminal, ensure you are in the root directory.
   - Run `gh valet configure`.
   - Use the down arrow key to highlight `Jenkins`, press the spacebar to select, then hit enter to accept.
   - At the prompt enter your GitHub Username and press enter.
@@ -45,7 +45,7 @@ In this lab, you will use the Valet `configure` command to set up the required i
   - At the GitHub url prompt enter the GitHub instance url or hit enter to accept the default, if you are using github.com then the default is the right choice.
   - At the Jenkins token prompt enter the Jenkins access token from step 1 and press enter.
   - At the Jenkins url prompt enter `http://localhost:8080/` and press enter.
-   - At the Personal access token to fetch source code in GitHub prompt, if any of your Jenkins pipelines have source code in a GitHub repository enter the GitHub PAT that would have acess to these files.
+   - At the Personal access token to fetch source code in GitHub prompt, if any of your Jenkins pipelines have source code in a GitHub repository enter the GitHub PAT that would have access to these files.
 4. If all went well you should see a similar output in your terminal:
   ![configure-result](https://user-images.githubusercontent.com/19557880/184041328-ce54ea22-b0cd-4c84-b02c-10ad7b09ad89.png)

@@ -19,7 +19,7 @@ These customizations will be present in many of our company's pipelines and an a

 ## Prerequisites

-1. Followed [steps](../jenkins/readme.md#valet-labs-for-jenkins) to set up your codespace environment and start your Jenkins instanace.
+1. Followed [steps](../jenkins/readme.md#valet-labs-for-jenkins) to set up your codespace environment and start your Jenkins instance.
 2. Completed the [configure lab](../jenkins/valet-configure-lab.md#configure-valet-to-work-with-jenkins) to configure the Valet CLI.
 3. Completed the [dry-run lab](../jenkins/valet-dry-run-lab.md#dry-run-the-migration-of-a-jenkins-pipeline-to-github-actions).

@@ -393,7 +393,7 @@ Thats it! Congratulations you have customized transforming:

 - unsupported steps
 - steps that are supported but don't meet your requirements
- enviroment variables
+- environment variables
 - runners

 ## Next Lab
@@ -10,7 +10,7 @@ The end result of this command will be the actions workflow written to your loca

 ## Prerequisites

-1. Followed [steps](../jenkins/readme.md#valet-labs-for-jenkins) to set up your codespace environment and start your Jenkins instanace.
+1. Followed [steps](../jenkins/readme.md#valet-labs-for-jenkins) to set up your codespace environment and start your Jenkins instance.
 2. Completed the [configure lab](../jenkins/valet-configure-lab.md#configure-valet-to-work-with-jenkins) to configure the Valet CLI.
 3. Completed the [audit lab](../Jenkins/valet-audit-lab.md#audit-jenkins-pipelines-using-the-valet-audit-command).

@@ -11,7 +11,7 @@ In this lab we will use the `forecast` command to forecast potential GitHub Acti

 ## Prerequisites

-1. Followed [steps](../jenkins/readme.md#valet-labs-for-jenkins) to set up your codespace environment and start your Jenkins instanace.
+1. Followed [steps](../jenkins/readme.md#valet-labs-for-jenkins) to set up your codespace environment and start your Jenkins instance.
 2. Completed the [configure lab](../jenkins/valet-configure-lab.md#configure-valet-to-work-with-jenkins) to configure the Valet CLI.

 ## Prepare for forecast
@@ -150,7 +150,7 @@ Here are some key terms of items defined in the forecast report:

 - The `job count` is the total number of completed jobs.
 - The `pipeline count` is the number of unique pipelines used.
- `Execution time` describe the amount of time a runner spent on a job. This metric can be used for a customer to help set expectations for the cost of GitHub hosted runners.
+- `Execution time` describes the amount of time a runner spent on a job. This metric can be used for a customer to help set expectations for the cost of GitHub hosted runners.
  - This metric is correlated to the amount of spend a customer should expect in GitHub Actions. This will vary greatly depending on the hardware the customer uses for these minutes and the Actions pricing calculator should be used to get an estimate of the approximate spend the customer should expect.
  - Looking closer we can see during our forecast timeframe the total job run time was 27,057 minutes with 90% of the jobs finishing under 20 minutes, and the longest job taking 15,625 minutes.  The `min` is 0 because the quickest job took less than a minute and was rounded down to 0.

@@ -13,7 +13,7 @@ The pull request will contain a checklist of `Manual Tasks` if required. These t

 ## Prerequisites

-1. Followed [steps](../jenkins/readme.md#valet-labs-for-jenkins) to set up your codespace environment and start your Jenkins instanace.
+1. Followed [steps](../jenkins/readme.md#valet-labs-for-jenkins) to set up your codespace environment and start your Jenkins instance.
 2. Completed the [configure lab](../jenkins/valet-configure-lab.md#configure-valet-to-work-with-jenkins) to configure the Valet CLI.
 3. Completed the [dry-run lab](../jenkins/valet-dry-run-lab.md#dry-run-the-migration-of-a-jenkins-pipeline-to-github-actions).
 4. Completed the [dry-run lab with custom transformer](../jenkins/valet-custom-transformers-lab.md#using-custom-transformers-in-a-dry-run).
@@ -41,11 +41,11 @@ Before running the command we need to collect some information:

 ## Reviewing the pull request

- Lets first look at the `Conversation` tab of the PR. It tells us we have a manual task to perform before the GitHub Actions workflow is functional.  We need to add a secret. We can use the GitHub [documentation](https://docs.github.com/en/actions/security-guides/encrypted-secrets#creating-encrypted-secrets-for-a-repository) for secrets and add a `actions` secret for `EXPRESSION_FIRST_VAR` with any value.
+- Let's first look at the `Conversation` tab of the PR. It tells us we have a manual task to perform before the GitHub Actions workflow is functional.  We need to add a secret. We can use the GitHub [documentation](https://docs.github.com/en/actions/security-guides/encrypted-secrets#creating-encrypted-secrets-for-a-repository) for secrets and add a `actions` secret for `EXPRESSION_FIRST_VAR` with any value.

  ![Manual steps](https://user-images.githubusercontent.com/19557880/186784161-b7882ac4-ac99-4462-b69f-f49b9202527b.png)

- Next, lets review the workflow we are adding by clicking on `Files changed` tab. This is where you would double check everything looks good. If it didn't you could push commits with the required changes, prior to merging.
+- Next, let's review the workflow we are adding by clicking on `Files changed` tab. This is where you would double check everything looks good. If it didn't you could push commits with the required changes, prior to merging.

 - Now our review is completed we want to go back to the `Conversation` tab and click `Merge pull request`