From 9154b3630e8f1b7f90ff46535854eabe12006d79 Mon Sep 17 00:00:00 2001 From: Anatole <95847530+Okaneeee@users.noreply.github.com> Date: Tue, 24 Oct 2023 19:39:20 +0200 Subject: [PATCH] Fix typos (#431) * ui: code readability * fix: typos --- docs/03-github-cloud-runner/01-introduction.mdx | 2 +- .../03-examples/01-command-line.mdx | 2 +- .../03-examples/02-github-examples/03-kubernetes.mdx | 2 +- .../06-advanced-topics/05-logging.mdx | 6 +++--- .../06-advanced-topics/06-secrets.mdx | 4 ++-- docs/03-github/03-test-runner.mdx | 2 +- docs/03-github/04-builder.mdx | 8 ++++---- .../version-2/03-github-cloud-runner/01-introduction.mdx | 2 +- .../03-examples/02-github-examples/03-kubernetes.mdx | 2 +- .../06-advanced-topics/05-logging.mdx | 2 +- .../06-advanced-topics/06-secrets.mdx | 4 ++-- 11 files changed, 18 insertions(+), 18 deletions(-) diff --git a/docs/03-github-cloud-runner/01-introduction.mdx b/docs/03-github-cloud-runner/01-introduction.mdx index f83e2103..d67936b5 100644 --- a/docs/03-github-cloud-runner/01-introduction.mdx +++ b/docs/03-github-cloud-runner/01-introduction.mdx @@ -66,7 +66,7 @@ indicates the stability and support for cloud runner features and workflows. | Azure | ⚠ Considered | ``` -_Note for Kuberentes support:_ _Usually the cluster needs to be up and running at all times, as +_Note for Kubernetes support:_ _Usually the cluster needs to be up and running at all times, as starting up a cluster is slow._ _Use Google Cloud's Kubernetes Autopilot you can scale down to the free tier automatically while not in use._ _Kubernetes support currently requires cloud storage, only S3 support is built-in._ diff --git a/docs/03-github-cloud-runner/03-examples/01-command-line.mdx b/docs/03-github-cloud-runner/03-examples/01-command-line.mdx index cc1afb5e..5c315d0f 100644 --- a/docs/03-github-cloud-runner/03-examples/01-command-line.mdx +++ b/docs/03-github-cloud-runner/03-examples/01-command-line.mdx @@ -27,7 +27,7 @@ dpx game-ci build # Help -_You can run `yarn run cli -h` or `yarn run cli --help` to List all modes and paramters with +_You can run `yarn run cli -h` or `yarn run cli --help` to list all modes and paramters with descriptions_ # Main Command Parameters diff --git a/docs/03-github-cloud-runner/03-examples/02-github-examples/03-kubernetes.mdx b/docs/03-github-cloud-runner/03-examples/02-github-examples/03-kubernetes.mdx index fe1f4a56..f77ee655 100644 --- a/docs/03-github-cloud-runner/03-examples/02-github-examples/03-kubernetes.mdx +++ b/docs/03-github-cloud-runner/03-examples/02-github-examples/03-kubernetes.mdx @@ -2,7 +2,7 @@ ## Requirements -- You must have a Kuberentes cluster setup and ready that supports persistent volumes. +- You must have a Kubernetes cluster setup and ready that supports persistent volumes. - Create a kubeconfig and encode it as base64. ## K8s Credentials diff --git a/docs/03-github-cloud-runner/06-advanced-topics/05-logging.mdx b/docs/03-github-cloud-runner/06-advanced-topics/05-logging.mdx index 9e4c9492..99660d31 100644 --- a/docs/03-github-cloud-runner/06-advanced-topics/05-logging.mdx +++ b/docs/03-github-cloud-runner/06-advanced-topics/05-logging.mdx @@ -1,13 +1,13 @@ # Logging -Logs are streamed from the workload to the Game CI origin unless you use the +Logs are streamed from the workload to the GameCI origin unless you use the ## Kubernetes -- Native kuberentes logging api +- Native Kubernetes logging api ## AWS - Fargate log to Cloud Watch - Subscription from Cloud Watch to Kinesis -- Game CI streams from logs from Kinesis +- GameCI streams from logs from Kinesis diff --git a/docs/03-github-cloud-runner/06-advanced-topics/06-secrets.mdx b/docs/03-github-cloud-runner/06-advanced-topics/06-secrets.mdx index e1dd64a9..17bae040 100644 --- a/docs/03-github-cloud-runner/06-advanced-topics/06-secrets.mdx +++ b/docs/03-github-cloud-runner/06-advanced-topics/06-secrets.mdx @@ -5,10 +5,10 @@ provider being used supports. ## Kubernetes -secrets are created as native kuberentes secret objects and mounted to job containers as env +Secrets are created as native Kubernetes secret objects and mounted to job containers as env variables. ## AWS -secrets are created as aws secret manager secrets and mounted to fargate tasks from secrets to env +Secrets are created as aws secret manager secrets and mounted to fargate tasks from secrets to env variables. diff --git a/docs/03-github/03-test-runner.mdx b/docs/03-github/03-test-runner.mdx index e9f3bac0..197ae5c0 100644 --- a/docs/03-github/03-test-runner.mdx +++ b/docs/03-github/03-test-runner.mdx @@ -350,7 +350,7 @@ Initializes Docker using the host network. This is useful if Unity needs to access a local server that was started as part of your workflow. -Options are: "true", "false" +Options are: `true`, `false` _**required:** `false`_ _**default:** `false`_ diff --git a/docs/03-github/04-builder.mdx b/docs/03-github/04-builder.mdx index db098756..82468b79 100644 --- a/docs/03-github/04-builder.mdx +++ b/docs/03-github/04-builder.mdx @@ -34,7 +34,7 @@ Create or edit the file called `.github/workflows/main.yml` and add a job to it. Personal licenses require a one-time manual activation step. -Make sure you [acquire and activate](/docs/github/activation) your license file and add it as a +Make sure you [acquire and activate](/docs/github/activation) your license file, and add it as a secret. Then, define the build step as follows: @@ -490,8 +490,8 @@ keys for your project and then add to the `webfactory/ssh-agent` and make sure that you you use `git@github.com:USER/PROJECT.git` instead of email for `-C` parameter because we're going to use it as deploy key for a single project and `webfactory/ssh-agent` going to use that for checking which repository this key is related to . -- Add the public_key to Deploy settings of your private git repository ( - https://github.com/USER/PROJECT/settings/keys) +- Add the public_key to Deploy settings of your private git repository + (https://github.com/USER/PROJECT/settings/keys) - Add private_key to Github secrets of the project that you want to build (https://github.com/USER/PROJECT/settings/secrets/actions) (key name should be SSH_PRIVATE_KEY ) - Add github to ssh known hosts : @@ -500,7 +500,7 @@ keys for your project and then add to the `webfactory/ssh-agent` name: 'Add GitHub to the SSH known hosts file' run: | mkdir -p -m 0700 /home/runner/.ssh - curl --silent https://api.github.com/meta | jq --raw-output '"github.com "+.ssh_keys[]' >> /home/runner/.ssh/known_hosts + curl --silent https://api.github.com/meta | jq --raw-output '"github.com "+.ssh_keys[]' >> /home/runner/.ssh/known_hosts chmod 600 /home/runner/.ssh/known_hosts ``` diff --git a/versioned_docs/version-2/03-github-cloud-runner/01-introduction.mdx b/versioned_docs/version-2/03-github-cloud-runner/01-introduction.mdx index f83e2103..d67936b5 100644 --- a/versioned_docs/version-2/03-github-cloud-runner/01-introduction.mdx +++ b/versioned_docs/version-2/03-github-cloud-runner/01-introduction.mdx @@ -66,7 +66,7 @@ indicates the stability and support for cloud runner features and workflows. | Azure | ⚠ Considered | ``` -_Note for Kuberentes support:_ _Usually the cluster needs to be up and running at all times, as +_Note for Kubernetes support:_ _Usually the cluster needs to be up and running at all times, as starting up a cluster is slow._ _Use Google Cloud's Kubernetes Autopilot you can scale down to the free tier automatically while not in use._ _Kubernetes support currently requires cloud storage, only S3 support is built-in._ diff --git a/versioned_docs/version-2/03-github-cloud-runner/03-examples/02-github-examples/03-kubernetes.mdx b/versioned_docs/version-2/03-github-cloud-runner/03-examples/02-github-examples/03-kubernetes.mdx index fe1f4a56..f77ee655 100644 --- a/versioned_docs/version-2/03-github-cloud-runner/03-examples/02-github-examples/03-kubernetes.mdx +++ b/versioned_docs/version-2/03-github-cloud-runner/03-examples/02-github-examples/03-kubernetes.mdx @@ -2,7 +2,7 @@ ## Requirements -- You must have a Kuberentes cluster setup and ready that supports persistent volumes. +- You must have a Kubernetes cluster setup and ready that supports persistent volumes. - Create a kubeconfig and encode it as base64. ## K8s Credentials diff --git a/versioned_docs/version-2/03-github-cloud-runner/06-advanced-topics/05-logging.mdx b/versioned_docs/version-2/03-github-cloud-runner/06-advanced-topics/05-logging.mdx index 9e4c9492..a14da8f4 100644 --- a/versioned_docs/version-2/03-github-cloud-runner/06-advanced-topics/05-logging.mdx +++ b/versioned_docs/version-2/03-github-cloud-runner/06-advanced-topics/05-logging.mdx @@ -4,7 +4,7 @@ Logs are streamed from the workload to the Game CI origin unless you use the ## Kubernetes -- Native kuberentes logging api +- Native Kubernetes logging api ## AWS diff --git a/versioned_docs/version-2/03-github-cloud-runner/06-advanced-topics/06-secrets.mdx b/versioned_docs/version-2/03-github-cloud-runner/06-advanced-topics/06-secrets.mdx index e1dd64a9..17bae040 100644 --- a/versioned_docs/version-2/03-github-cloud-runner/06-advanced-topics/06-secrets.mdx +++ b/versioned_docs/version-2/03-github-cloud-runner/06-advanced-topics/06-secrets.mdx @@ -5,10 +5,10 @@ provider being used supports. ## Kubernetes -secrets are created as native kuberentes secret objects and mounted to job containers as env +Secrets are created as native Kubernetes secret objects and mounted to job containers as env variables. ## AWS -secrets are created as aws secret manager secrets and mounted to fargate tasks from secrets to env +Secrets are created as aws secret manager secrets and mounted to fargate tasks from secrets to env variables.