feat: automatically wrap prose (#291)

Co-authored-by: David Finol <[email protected]>

.github/pull_request_template.md

@@ -6,6 +6,7 @@
 
 <!-- please check all items and add your own -->
 
-- [ ] Read the contribution [guide](../blob/main/CONTRIBUTING.md) and accept the [code](../blob/main/CODE_OF_CONDUCT.md) of conduct
+- [ ] Read the contribution [guide](../blob/main/CONTRIBUTING.md) and accept the
+      [code](../blob/main/CODE_OF_CONDUCT.md) of conduct
 - [ ] Readme (updated or not needed)
 - [ ] Tests (added, updated or not needed)

.prettierrc.json

@@ -2,5 +2,6 @@
   "semi": true,
   "singleQuote": true,
   "trailingComma": "all",
-  "printWidth": 100
+  "printWidth": 100,
+  "proseWrap": "always"
 }

CODE_OF_CONDUCT.md

@@ -2,17 +2,15 @@
 
 ## Our Pledge
 
-In the interest of fostering an open and welcoming environment, we as
-contributors and maintainers pledge to making participation in our project and
-our community a harassment-free experience for everyone, regardless of age, body
-size, disability, ethnicity, sex characteristics, gender identity and expression,
-level of experience, education, socio-economic status, nationality, personal
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers
+pledge to making participation in our project and our community a harassment-free experience for
+everyone, regardless of age, body size, disability, ethnicity, sex characteristics, gender identity
+and expression, level of experience, education, socio-economic status, nationality, personal
 appearance, race, religion, or sexual identity and orientation.
 
 ## Our Standards
 
-Examples of behavior that contributes to creating a positive environment
-include:
+Examples of behavior that contributes to creating a positive environment include:
 
 - Using welcoming and inclusive language
 - Being respectful of differing viewpoints and experiences
@@ -22,53 +20,47 @@ include:
 
 Examples of unacceptable behavior by participants include:
 
-- The use of sexualized language or imagery and unwelcome sexual attention or
-  advances
+- The use of sexualized language or imagery and unwelcome sexual attention or advances
 - Trolling, insulting/derogatory comments, and personal or political attacks
 - Public or private harassment
-- Publishing others' private information, such as a physical or electronic
-  address, without explicit permission
-- Other conduct which could reasonably be considered inappropriate in a
-  professional setting
+- Publishing others' private information, such as a physical or electronic address, without explicit
+  permission
+- Other conduct which could reasonably be considered inappropriate in a professional setting
 
 ## Our Responsibilities
 
-Project maintainers are responsible for clarifying the standards of acceptable
-behavior and are expected to take appropriate and fair corrective action in
-response to any instances of unacceptable behavior.
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are
+expected to take appropriate and fair corrective action in response to any instances of unacceptable
+behavior.
 
-Project maintainers have the right and responsibility to remove, edit, or
-reject comments, commits, code, wiki edits, issues, and other contributions
-that are not aligned to this Code of Conduct, or to ban temporarily or
-permanently any contributor for other behaviors that they deem inappropriate,
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits,
+code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or
+to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate,
 threatening, offensive, or harmful.
 
 ## Scope
 
-This Code of Conduct applies both within project spaces and in public spaces
-when an individual is representing the project or its community. Examples of
-representing a project or community include using an official project e-mail
-address, posting via an official social media account, or acting as an appointed
-representative at an online or offline event. Representation of a project may be
+This Code of Conduct applies both within project spaces and in public spaces when an individual is
+representing the project or its community. Examples of representing a project or community include
+using an official project e-mail address, posting via an official social media account, or acting as
+an appointed representative at an online or offline event. Representation of a project may be
 further defined and clarified by project maintainers.
 
 ## Enforcement
 
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at [email protected]. All
-complaints will be reviewed and investigated and will result in a response that
-is deemed necessary and appropriate to the circumstances. The project team is
-obligated to maintain confidentiality with regard to the reporter of an incident.
-Further details of specific enforcement policies may be posted separately.
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting
+the project team at [email protected]. All complaints will be reviewed and investigated and will
+result in a response that is deemed necessary and appropriate to the circumstances. The project team
+is obligated to maintain confidentiality with regard to the reporter of an incident. Further details
+of specific enforcement policies may be posted separately.
 
-Project maintainers who do not follow or enforce the Code of Conduct in good
-faith may face temporary or permanent repercussions as determined by other
-members of the project's leadership.
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face
+temporary or permanent repercussions as determined by other members of the project's leadership.
 
 ## Attribution
 
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
-available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at
+https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
 
 [homepage]: https://www.contributor-covenant.org
 

CONTRIBUTING.md

@@ -1,63 +1,52 @@
 # Contributing
 
-## How to Contribute
+## Code of Conduct
 
-#### Code of Conduct
+This repository has adopted the Contributor Covenant as it's Code of Conduct. It is expected that
+participants adhere to it.
 
-This repository has adopted the Contributor Covenant as it's
-Code of Conduct. It is expected that participants adhere to it.
+## Proposing a Change
 
-#### Proposing a Change
-
-If you are unsure about whether or not a change is desired,
-you can create an issue. This is useful because it creates
-the possibility for a discussion that's visible to everyone.
+If you are unsure about whether or not a change is desired, you can create an issue. This is useful
+because it creates the possibility for a discussion that's visible to everyone.
 
 When fixing a bug it is fine to submit a pull request right away.
 
-#### Sending a Pull Request
-
-Steps to be performed to submit a pull request:
-
-1. Fork the repository and create your branch from `main`.
-2. Run `yarn` in the repository root.
-3. If you've fixed a bug or added code that should be tested, add tests!
-4. Run `yarn build` and make sure no errors are generated in the console before creating the PR.
-5. Fill out the description, link any related issues and submit your pull request.
+## Setup
 
-#### Pull Request Prerequisites
-
-##### Tools
+### Tools
 
 You need the following tools to be installed.
 
-- [Node](https://nodejs.org/) installed at v12.X.
-- [Yarn](https://yarnpkg.com/) at v1.18.0+.
+- [Node](https://nodejs.org/) installed at v16.X.
+- [Yarn](https://yarnpkg.com/) at v1.22.4+.
 
-> **Tip:** _Use
-> [nvm](https://github.com/nvm-sh/nvm) or
-> [n](https://github.com/tj/n) or
-> [nodenv](https://github.com/nodenv/nodenv)
-> to manage Node.js versions on your machine._
+> **Tip:** _Use [nvm](https://github.com/nvm-sh/nvm) or [n](https://github.com/tj/n) or
+> [nodenv](https://github.com/nodenv/nodenv) to manage Node.js versions on your machine._
 
-##### Plugins
+### Plugins
 
 Install and enable plugins for your IDE:
 
 - ESLint
-- Prettier - _Enable auto format on save:
-  ([WebStorm](https://www.jetbrains.com/help/idea/prettier.html#ws_prettier_configure),
+- [Prettier](https://prettier.io/) - Enable auto format on save:
+  _([WebStorm](https://www.jetbrains.com/help/idea/prettier.html#ws_prettier_configure),
   [PhpStorm](https://www.jetbrains.com/help/idea/prettier.html#ws_prettier_configure),
-  [VS Code](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode#format-on-save))._
+  [VS Code](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode#format-on-save))_.
+
+<img width="977" src="media/prettier-in-webstorm.png" alt="Prettier configuration" />
 
-##### Knowledge
+## Sending a Pull Request
 
-Please note that commit hooks will run automatically to perform some tasks;
+Steps to be performed to submit a pull request:
 
-- format your code
-- run tests
-- build distributable files
+1. Fork the repository and create your branch from `main`.
+2. Run `yarn` in the repository root.
+3. If you've fixed a bug or added code that should be tested, add tests!
+4. Run `yarn build` and make sure no errors are generated in the console before creating the PR.
+5. Fill out the description, link any related issues and submit your pull request.
 
-#### License
+## License
 
-By contributing to this repository, you agree that your contributions will be licensed under its MIT license.
+By contributing to this repository, you agree that your contributions will be licensed under its MIT
+license.

README.md

@@ -1,8 +1,8 @@
 # GameCI
 
-Documentation for open source GameCI projects. You can find the `.md` files inside the [docs](./docs) folder.
-The live version is available on [game.ci](https://game.ci). This website is built using
-[Docusaurus 2](https://docusaurus.io/), a modern static website generator.
+Documentation for open source GameCI projects. You can find the `.md` files inside the
+[docs](./docs) folder. The live version is available on [game.ci](https://game.ci). This website is
+built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
 
 ### Installation
 
@@ -16,21 +16,22 @@ yarn
 yarn start
 ```
 
-This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the 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.
 
 ### Build
 
 ```bash
 yarn build
 ```
 
-This command generates static content into the `build` directory and can be served using any static contents hosting service.
+This command generates static content into the `build` directory and can be served using any static
+contents hosting service.
 
 ## Community
 
-Feel free to join us on
-[![Discord](assets/readme/Discord.svg)](https://game.ci/discord)
-and engage with the community.
+Feel free to join us on [![Discord](assets/readme/Discord.svg)](https://game.ci/discord) and engage
+with the community.
 
 ## Support us
 

blog/authors.yml

@@ -12,12 +12,16 @@ webbertakken:
 
 frostebite:
   name: Mark D. "Fisher"
-  title: Lead game developer @bossastudios, former product manager @unity3d, arma modder. Game ai, networking, terrain
+  title:
+    Lead game developer @bossastudios, former product manager @unity3d, arma modder. Game ai,
+    networking, terrain
   url: https://www.bossastudios.com/
   image_url: https://images.opencollective.com/frostebite/b35bd63/avatar/256.png
 
 davidmfinol:
   name: David Finol
-  title: Lead developer @bossastudios, former product manager @unity3d, arma modder. Game ai, networking, terrain
+  title:
+    Lead developer @bossastudios, former product manager @unity3d, arma modder. Game ai, networking,
+    terrain
   url: https://github.com/davidmfinol
   image_url: https://github.com/davidmfinol.png

docs/02-getting-started/index.mdx

@@ -1,6 +1,7 @@
 # Getting started
 
-The term for automatically testing, building, and deploying your project is Continuous Integration, or CI for short.
+The term for automatically testing, building, and deploying your project is Continuous Integration,
+or CI for short.
 
 The configuration for CI, we commonly call a CI-workflow.
 
@@ -12,10 +13,16 @@ To get started creating your workflow, you need 3 things:
 
 ## Preparing the project
 
-**Create a repository** on your chosen Git host and follow their instructions to commit and push your project.
+**Create a repository** on your chosen Git host and follow their instructions to commit and push
+your project.
 
-Be sure to **ignore any automatically generated files**, by adding the reference [.gitignore](https://github.com/github/gitignore/blob/master/Unity.gitignore) file to the root of your project.
+Be sure to **ignore any automatically generated files**, by adding the reference
+[.gitignore](https://github.com/github/gitignore/blob/master/Unity.gitignore) file to the root of
+your project.
 
-To **ensure large files are handled correctly** (in [LFS](https://git-lfs.github.com/)), you can add our reference [.gitattributes](https://gist.github.com/webbertakken/ff250a0d5e59a8aae961c2e509c07fbc) file to the root of your project.
+To **ensure large files are handled correctly** (in [LFS](https://git-lfs.github.com/)), you can add
+our reference
+[.gitattributes](https://gist.github.com/webbertakken/ff250a0d5e59a8aae961c2e509c07fbc) file to the
+root of your project.
 
 You are now **ready** to create a workflow! Choose the CI system you chose in the menu on the left.

docs/03-github-cloud-runner/01-introduction.mdx

@@ -2,45 +2,55 @@
 
 ## Concept - What Does Cloud Runner Do
 
-**Cloud Runner enables you to run, build and test workflows in the cloud, right from GitHub actions. Builder will automatically provision an environment at a Cloud Provider such as GCP and AWS. It will then send the project to be built and/or tested depending on your workflow configuration.**
+**Cloud Runner enables you to run, build and test workflows in the cloud, right from GitHub actions.
+Builder will automatically provision an environment at a Cloud Provider such as GCP and AWS. It will
+then send the project to be built and/or tested depending on your workflow configuration.**
 
-**Cloud Runner is especially useful for game development because it supports large projects. Cloud Runner provides first class support for the Unity game engine.**
+**Cloud Runner is especially useful for game development because it supports large projects. Cloud
+Runner provides first class support for the Unity game engine.**
 
-Cloud Runner uses git to track and transfer your projects and uses native cloud services such as AWS Fargate and Kubernetes to run your jobs. Other version control systems are not actively supported.
+Cloud Runner uses git to track and transfer your projects and uses native cloud services such as AWS
+Fargate and Kubernetes to run your jobs. Other version control systems are not actively supported.
 
 ## Why cloud runner?
 
-1. Extended options and more control over disk size, memory and CPU. You can build projects of almost any size.
+1. Extended options and more control over disk size, memory and CPU. You can build projects of
+   almost any size.
 2. Scale up to much larger numbers of builds easily and fully on demand.
 3. Run custom jobs and extend the system for any workload.
-4. Create resources on-demand, we have made an effort to make sure that it costs you nothing while there are no builds running (no guarantees).
+4. Create resources on-demand, we have made an effort to make sure that it costs you nothing while
+   there are no builds running (no guarantees).
 
 ## Why not cloud runner?
 
 1. Your project is small in size. Below 5GB Cloud Runner should not be needed.
 2. You already have servers running you can use for capacity.
 3. You strongly prefer to avoid the addition of time to your pipeline, slowing down results.
 
-Although the speed of a CI pipelines is an important metric to consider, there are real challenges for game development pipelines.
+Although the speed of a CI pipelines is an important metric to consider, there are real challenges
+for game development pipelines.
 
 This solution prefers convenience, ease of use, scalability, throughput and flexibility.
 
-Faster solutions exist, but would all involve self-hosted hardware with an immediate local cache of the large project files and working directory and a dedicated server.
+Faster solutions exist, but would all involve self-hosted hardware with an immediate local cache of
+the large project files and working directory and a dedicated server.
 
 ## Cloud Runner Release Status
 
 Cloud Runner is in "active development" ⚠️🔨
 
-Cloud Runner overall release status: `preview`
-This means some APIs may change, features are still being added but the minimum feature set works and is stable.
+Cloud Runner overall release status: `preview` This means some APIs may change, features are still
+being added but the minimum feature set works and is stable.
 
 Release Stages: `experimental` ➡️ `preview` ➡️ `full release`
 
-You must use a provider with Cloud Runner, each provider's release status is described below. This indicates the stability and support for cloud runner features and workflows.
+You must use a provider with Cloud Runner, each provider's release status is described below. This
+indicates the stability and support for cloud runner features and workflows.
 
 ### Development
 
-_Cloud Runner is actively maintained and kept stable by the Game CI open source project contributors._
+_Cloud Runner is actively maintained and kept stable by the Game CI open source project
+contributors._
 
 💬suggestions, 🐛bugs and ↕️Minor changes are tracked as GitHub issues:
 
@@ -66,9 +76,9 @@ You can also explore the [development roadmap page](development).
 | Azure                   | ⚠ Considered            |
 ```
 
-_Note for Kuberentes 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._
+_Note for Kuberentes 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._
 
 ```md
 | Git Platform          | Release Status     |
@@ -88,4 +98,5 @@ All cloud runner releases are currently packaged and released with game-ci's uni
 History up to latest open incoming changes for release can be found here:
 [Cloud Runner PRs - GitHub](https://github.com/game-ci/unity-builder/pulls?q=is%3Apr+cloud+runner)
 
-You can see further information about configuring the release version on the [Configuration](configuration) page.
+You can see further information about configuring the release version on the
+[Configuration](configuration) page.