Skip to content

Commit

Permalink
Fix typos (#431)
Browse files Browse the repository at this point in the history
* ui: code readability

* fix: typos
  • Loading branch information
Okaneeee authored Oct 24, 2023
1 parent 8a8a225 commit 9154b36
Show file tree
Hide file tree
Showing 11 changed files with 18 additions and 18 deletions.
2 changes: 1 addition & 1 deletion docs/03-github-cloud-runner/01-introduction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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._
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 3 additions & 3 deletions docs/03-github-cloud-runner/06-advanced-topics/05-logging.mdx
Original file line number Diff line number Diff line change
@@ -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
4 changes: 2 additions & 2 deletions docs/03-github-cloud-runner/06-advanced-topics/06-secrets.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.
2 changes: 1 addition & 1 deletion docs/03-github/03-test-runner.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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`_

Expand Down
8 changes: 4 additions & 4 deletions docs/03-github/04-builder.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -490,8 +490,8 @@ keys for your project and then add to the `webfactory/ssh-agent`
and make sure that you you use `[email protected]: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 :
Expand All @@ -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
```

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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._
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.

0 comments on commit 9154b36

Please sign in to comment.