From da43e6b30f3233a1b7b0100d4666bf299fc64ab4 Mon Sep 17 00:00:00 2001 From: Lav Jain Date: Wed, 11 Oct 2023 14:13:22 -0400 Subject: [PATCH] Correct minor typos in docs --- CONTRIBUTING.md | 2 +- docs/CLI_USAGE.md | 2 +- docs/INSTALLATION.md | 2 +- e2e/template_e2e_tests/README.md | 4 ++-- 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3a9e8416..bd3403f5 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -6,7 +6,7 @@ If you are looking for the general development guide for the generated code from ## Bug Reports -If you encounter any issues or bugs, please [file a new Github Issue](https://github.com/GoogleCloudPlatform/solutions-builder/issues/new). +If you encounter any issues or bugs, please [file a new GitHub Issue](https://github.com/GoogleCloudPlatform/solutions-builder/issues/new). - The Google team will triage the issues and will reply to your issues shortly. diff --git a/docs/CLI_USAGE.md b/docs/CLI_USAGE.md index fa600cad..72712d71 100644 --- a/docs/CLI_USAGE.md +++ b/docs/CLI_USAGE.md @@ -1,4 +1,4 @@ -# Solution Builder CLI Usage +# Solutions Builder CLI Usage ## Global Variables diff --git a/docs/INSTALLATION.md b/docs/INSTALLATION.md index d8f3db9c..d7dcfbed 100644 --- a/docs/INSTALLATION.md +++ b/docs/INSTALLATION.md @@ -272,7 +272,7 @@ Once updated, open the browser to the Cloud Run service's URL, and you'll see th An infra component is nothing but another component. Some component contains just infra pieces in `terraform/modules` or `terraform/stages` folders. Other component may contain both `component/service_name` as a microservice **AND** required infra resources in `terraform/stages`. -To add an infra component, run the same command like adding a regular component. +To add an infra component, run the same command as adding a regular component. ``` sb components add [COMPONENT_NAME] ``` diff --git a/e2e/template_e2e_tests/README.md b/e2e/template_e2e_tests/README.md index e7082069..c22070d1 100644 --- a/e2e/template_e2e_tests/README.md +++ b/e2e/template_e2e_tests/README.md @@ -4,7 +4,7 @@ This doc covers the setup and steps required for running e2e tests for Template. ## Setup -> Currently, we run into issues of creating a brand new project for every e2e test. Hence we use one static project for e2e testing with resources clean up. +> Currently, we run into issues of creating a brand-new project for every e2e test. Hence, we use one static project for e2e testing with resources clean up. - Create an org-level service account as e2e-runner: > This service account can be created separately under another GCP project with granted permissions on the org-level. @@ -75,7 +75,7 @@ This doc covers the setup and steps required for running e2e tests for Template. bash ./e2e/template_e2e_tests/run_e2e_test.sh ``` -## Run E2E tests with Github Actions for E2E tests +## Run E2E tests with GitHub Actions for E2E tests Add the following secrets to the `e2e` group: