Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix typos #428

Merged
merged 1 commit into from
Oct 12, 2023
Merged

Fix typos #428

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 12 additions & 16 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,26 +16,26 @@

## Welcome

Welcome to the GameCI documentation repo! Here you will find the documentation assests for GameCI
and it's related open-source projects. The live documentation site availble at
<a href="https://game.ci">game.ci</a>.
Welcome to the GameCI documentation repo! Here you will find the documentation assets for GameCI and
it's related open-source projects. The live documentation site available at
<a href="https://game.ci">game.ci</a>.

You may also view the markdown files directly at the following links:

- [Getting Started with GameCI](docs/02-getting-started)
- [Github Actions](docs/03-github)
- [Gitlab Pipelines](docs/05-gitlab)
- [CircleCi<](docs/11-circleci)
- [GitHub Actions](docs/03-github)
- [GitLab Pipelines](docs/05-gitlab)
- [CircleCi](docs/11-circleci)
- [Docker](docs/08-docker)
- [Github Cloud Runner](docs/03-github-cloud-runner)
- [GitHub Cloud Runner](docs/03-github-cloud-runner)
- [Troubleshooting](docs/09-troubleshooting)
- [FAQ](docs/10-faq)

## Building the Docs Site

Built with [Docusaurus 2.](https://docusaurus.io/)

This project has a hard dependancy on Node16. You will need to make sure that you have the proper
This project has a hard dependency on Node16. You will need to make sure that you have the proper
version of node installed to avoid errors.

- [Install Node16 on Ubuntu](https://joshtronic.com/2021/05/09/how-to-install-nodejs-16-on-ubuntu-2004-lts/)
Expand All @@ -46,13 +46,13 @@ and test the documentation site.

- [Official yarn installation docs.](https://classic.yarnpkg.com/lang/en/docs/install)

1. Install project dependancies
1. Install project dependencies

```bash
yarn install
```

2. Start a local develpment server
2. Start a local development server

This command starts a local development server and opens up a browser window. Most changes are
reflected live without having to restart the server.
Expand All @@ -76,13 +76,9 @@ everyday.

## Support the Team

GameCI is free for everyone forever. You can support the peolpe who make GameCI pssible on
GameCI is free for everyone forever. You can support the people who make GameCI possible on
[OpenCollective](https://opencollective.com/game-ci)

## Licence
## License

This repository is [MIT](./LICENSE) licensed. This includes all contributions from the community.

## Sponsors

<img src="https://img.shields.io/badge/Vercel-000000?style=for-the-badge&logo=vercel&logoColor=white" href="https://vercel.com?utm_source=game-ci">
22 changes: 11 additions & 11 deletions docs/09-troubleshooting/common-issues.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -233,17 +233,6 @@ There are 2 possible solutions:
- Remove emojis from all environment variables (and thus workflow files), or
- Upgrade your project and workflow to use Unity editor version 2020.2 or later.

## General tips

These are tips that are usually applicable to problems you may encounter while working with a game
engine and CI/CD:

- Try to isolate your problem as much as possible
- Try with a blank project, this will help you to isolate your problem. Is it a something with your
project specifically or is it with Unity or GameCI?
- Try to search for error keywords in your message such as `error`, `failed`, `exception`, etc.
- Read the error message closely to understand what's going on.

### No space left on device

#### Error
Expand All @@ -263,6 +252,17 @@ try using
or using
[Cloud Runners](https://game.ci/docs/github-cloud-runner/game-ci-vs-cloud-runner#large-github-projects).

## General tips

These are tips that are usually applicable to problems you may encounter while working with a game
engine and CI/CD:

- Try to isolate your problem as much as possible
- Try with a blank project, this will help you to isolate your problem. Is it a something with your
project specifically or is it with Unity or GameCI?
- Try to search for error keywords in your message such as `error`, `failed`, `exception`, etc.
- Read the error message closely to understand what's going on.

## Still having problems?

You can **search for existing issues**:
Expand Down
Loading