Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,27 +20,27 @@
</p>

Gitpod is an open-source Kubernetes application for ready-to-code developer environments that spins up fresh, automated dev environments
for each task, in the cloud, in seconds. It enables you to describe your dev environment as code and start instant, remote and cloud-based developer environments directly from your browser or your Desktop IDE.
for each task, in the cloud, in seconds. It enables you to describe thy dev environment as code and start instant, remote and cloud-based developer environments directly from thy browser or thy Desktop IDE.

Tightly integrated with GitLab, GitHub, and Bitbucket, Gitpod automatically and continuously prebuilds dev environments for all your branches. As a result, team members can instantly start coding with fresh, ephemeral, and fully-compiled dev environments - no matter if you are building a new feature, want to fix a bug, or do a code review.
Tightly integrated with GitLab, GitHub, and Bitbucket, Gitpod automatically and continuously prebuilds dev environments for all thy branches. As a result, team members can instantly start coding with fresh, ephemeral, and fully-compiled dev environments - no matter if you are building a new feature, want to fix a bug, or do a code review.

![browser-vscode](https://user-images.githubusercontent.com/22498066/135150975-23bba3a6-f099-48c5-83ed-a1a6627ff0e9.png)

## Features

🏗 [Dev environments as code](https://www.gitpod.io/docs/#-dev-environments-as-code) - Gitpod applies lessons learned from infrastructure-as-code. Spinning up dev environments is easily repeatable and reproducible empowering you to automate, version-control, and share dev environments across your team.
🏗 [Dev environments as code](https://www.gitpod.io/docs/#-dev-environments-as-code) - Gitpod applies lessons learned from infrastructure-as-code. Spinning up dev environments is easily repeatable and reproducible empowering you to automate, version-control, and share dev environments across thy team.

⚡️ [Prebuilt dev environments](https://www.gitpod.io/docs/#prebuilds) - Gitpod continuously prebuilds all your git branches similar to a CI server. Control how Gitpod pre-configures and initializes environments before you even start a workspace through `init` commands in your `.gitpod.yml`.
⚡️ [Prebuilt dev environments](https://www.gitpod.io/docs/#prebuilds) - Gitpod continuously prebuilds all thy git branches similar to a CI server. Control how Gitpod pre-configures and initializes environments before you even start a workspace through `init` commands in thy `.gitpod.yml`.

🐳 [Integrated Docker build](https://www.gitpod.io/docs/config-docker/) - Gitpod instantly starts a container in the cloud based on your Docker image. Tools that are required for your project are easy to install and configure.
🐳 [Integrated Docker build](https://www.gitpod.io/docs/config-docker/) - Gitpod instantly starts a container in the cloud based on thy Docker image. Tools that are required for thy project are easy to install and configure.

👐 [GitLab, GitHub, and Bitbucket integration](https://www.gitpod.io/docs/integrations/) - Gitpod seamlessly integrates into your workflow and works with all major git hosting platforms including GitHub, GitLab and Bitbucket.
👐 [GitLab, GitHub, and Bitbucket integration](https://www.gitpod.io/docs/integrations/) - Gitpod seamlessly integrates into thy workflow and works with all major git hosting platforms including GitHub, GitLab and Bitbucket.

👀 [Integrated code reviews](https://www.gitpod.io/docs/context-urls#pullmerge-request-context) - with Gitpod you can do native code reviews on any PR/MR. No need to switch context anymore and clutter your local machine with your colleagues' PR/MR.
👀 [Integrated code reviews](https://www.gitpod.io/docs/context-urls#pullmerge-request-context) - with Gitpod you can do native code reviews on any PR/MR. No need to switch context anymore and clutter thy local machine with thy colleagues' PR/MR.

👯‍♀️ [Collaboration](https://www.gitpod.io/docs/sharing-and-collaboration/) - invite team members to your dev environment or snapshot any state of your dev environment to share it with your team asynchronously.
👯‍♀️ [Collaboration](https://www.gitpod.io/docs/sharing-and-collaboration/) - invite team members to thy dev environment or snapshot any state of thy dev environment to share it with thy team asynchronously.

🛠 Professional & customizable developer experience - a Gitpod workspace gives you the same capabilities (yes, even [root & docker](https://www.gitpod.io/docs/config-docker#configure-a-custom-dockerfile)) as your Linux machine - pre-configured and optimized for your individual development workflow. Install any [VS Code extension](https://www.gitpod.io/docs/vscode-extensions/) with one click on a user and/or team level.
🛠 Professional & customizable developer experience - a Gitpod workspace gives you the same capabilities (yes, even [root & docker](https://www.gitpod.io/docs/config-docker#configure-a-custom-dockerfile)) as thy Linux machine - pre-configured and optimized for thy individual development workflow. Install any [VS Code extension](https://www.gitpod.io/docs/vscode-extensions/) with one click on a user and/or team level.

[Learn more 👉](https://www.gitpod.io/)

Expand All @@ -51,7 +51,7 @@ Gitpod is provided as a [managed Saas version](https://gitpod.io) with a free su
You can start using Gitpod in one or more of the following ways:

1. Quickstart using an [Example Project](https://www.gitpod.io/docs/quickstart) or [OSS Project](https://contribute.dev/)
1. Getting started with [one of your existing projects](https://www.gitpod.io/docs/getting-started)
1. Getting started with [one of thy existing projects](https://www.gitpod.io/docs/getting-started)
1. [Use a Prefixed URL](https://www.gitpod.io/docs/getting-started/#prefixed-url)
1. [Install Browser Extension](https://www.gitpod.io/docs/getting-started#browser-extension)
1. [Enable GitLab Integration](https://www.gitpod.io/docs/gitlab-integration#gitlab-integration)
Expand Down
2 changes: 1 addition & 1 deletion components/common-go/nsenter/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ The `nsenter` package registers a special init constructor that is called before
the Go runtime has a chance to boot. This provides us the ability to `setns` on
existing namespaces and avoid the issues that the Go runtime has with multiple
threads. This constructor will be called if this package is registered,
imported, in your go application.
imported, in thy go application.

The `nsenter` package will `import "C"` and it uses [cgo](https://golang.org/cmd/cgo/)
package. In cgo, if the import of "C" is immediately preceded by a comment, that comment,
Expand Down
10 changes: 5 additions & 5 deletions components/dashboard/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,24 +40,24 @@ All the commands in this section are meant to be executed from the `components/d

### 1. Environment variables

Set the following 2 [environment variables](https://www.gitpod.io/docs/environment-variables) either [via your account settings](https://gitpod.io/variables) or [via the command line](https://www.gitpod.io/docs/environment-variables#using-the-command-line-gp-env).
Set the following 2 [environment variables](https://www.gitpod.io/docs/environment-variables) either [via thy account settings](https://gitpod.io/variables) or [via the command line](https://www.gitpod.io/docs/environment-variables#using-the-command-line-gp-env).

You are not expected to update the values of these variables for a long time after you first set them.

> **🚨 Heads up!** Be careful when using the command line, as the `gp` CLI will restrict the scope of the variables to the current project, meaning if you are not already working from your own personal fork you'll end up having variables you can't access when you do.
> **🚨 Heads up!** Be careful when using the command line, as the `gp` CLI will restrict the scope of the variables to the current project, meaning if you are not already working from thy own personal fork you'll end up having variables you can't access when you do.

You can always go to your account settings and edit the scope for each variable to something like `*/gitpod`.
You can always go to thy account settings and edit the scope for each variable to something like `*/gitpod`.

```bash
# Use "gitpod.io" for the SaaS version of Gitpod, or specify the host of your self-hosted gitpod
# Use "gitpod.io" for the SaaS version of Gitpod, or specify the host of thy self-hosted gitpod
GP_DEV_HOST=gitpod.io

# Notice the cookie name (_gitpod_io_) may be different if self-hosted.
# Read below for how to get the actual value to use instead of "AUTHENTICATION_COOKIE_VALUE"
GP_DEV_COOKIE="_gitpod_io_=AUTHENTICATION_COOKIE_VALUE"
```

Replace `AUTHENTICATION_COOKIE_VALUE` with the value of your auth cookie taken from your browser's dev tools while visiting your target Gitpod host (e.g. `s%3Axxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.XXXXXXXXXXXXXXX`).
Replace `AUTHENTICATION_COOKIE_VALUE` with the value of thy auth cookie taken from thy browser's dev tools while visiting thy target Gitpod host (e.g. `s%3Axxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.XXXXXXXXXXXXXXX`).

| ℹ️ How to get the cookie name and value |
| -------------------------------------------------------------------------- |
Expand Down
2 changes: 1 addition & 1 deletion components/gitpod-db/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Contains all the database related functionality, implemented using [typeorm](https://typeorm.io/).

### Working on gitpod-protocol component
When you are making changes to gitpod-protocol component, make sure to run `yarn build` in gitpod-protocol folder to make sure your changes will be rebuild. Also consider running `yarn watch` so that any changes are rebuilt in realtime.
When you are making changes to gitpod-protocol component, make sure to run `yarn build` in gitpod-protocol folder to make sure thy changes will be rebuild. Also consider running `yarn watch` so that any changes are rebuilt in realtime.

### Adding a new table
1. Create a [migration](./src/typeorm/migration/README.md) - use the [baseline](./src/typeorm/migration/1592203031938-Baseline.ts) as an exemplar
Expand Down
2 changes: 1 addition & 1 deletion components/ide/jetbrains/backend-plugin/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ you experience any issues with JetBrains remote dev make sure to report
issues [here](https://youtrack.jetbrains.com/issues?q=project:%20CWM)
under remote development subsystem.

Usually you will need to create a preview environments to try your changes, but if your changes don't touch any other
Usually you will need to create a preview environments to try thy changes, but if thy changes don't touch any other
components beside the backend plugin then you can test against the running workspace:

- Launch `./launch-dev-server.sh` from `components/ide/jetbrains/backend-plugin`. It builds the backend plugin, and
Expand Down
2 changes: 1 addition & 1 deletion components/local-app/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,5 +15,5 @@ docker run --rm -it -v /tmp/dest:/out eu.gcr.io/gitpod-core-dev/build/local-app:
## How to run in Gitpod against a dev-staging environment
```
cd components/local-app
BROWSER= GITPOD_HOST=<URL-of-your-preview-env> go run main.go --mock-keyring run
BROWSER= GITPOD_HOST=<URL-of-thy-preview-env> go run main.go --mock-keyring run
```
2 changes: 1 addition & 1 deletion components/ws-manager/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ You can start `ws-manager` in any Kubernetes cluster, it will only look at pods
To run `ws-manager` you need:
1. _messagebus you can connect to:_ e.g. `kubectl port-forward deployment/messagebus 5672`
2. _valid configuration file:_ e.g. `example-config.json`. You can use `wsman validate-config --config example-config.json` to make sure you have a valid configuration file.
3. _Kubernetes cluster to work with:_ you can use your `kubectl` config file using the `--kubeconfig` flag or otherwise have it connect to the cluster it's running in
3. _Kubernetes cluster to work with:_ you can use thy `kubectl` config file using the `--kubeconfig` flag or otherwise have it connect to the cluster it's running in

Then run `wsman run --config example-config.json --kubeconfig ~/.kube/config -v`

Expand Down
2 changes: 1 addition & 1 deletion dev/blowtorch/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ blowtorch is a tool to selectively burn down bridges, i.e. Kubernetes service co
## Usage

```
blowtorch helps using toxiproxy to create network chaos in your k8s application
blowtorch helps using toxiproxy to create network chaos in thy k8s application

Usage:
blowtorch [command]
Expand Down
4 changes: 2 additions & 2 deletions dev/loadgen/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ A load generator (framework) for Gitpod.
You can find a short explanation of this tool in this [loom video](https://www.loom.com/share/6487e3403c0746cc97bb3f766e15fab6).

## How to run a benchmark
- Ensure your kubeconfig has the configuration for the cluster you want to benchmark. You can use kubecdl to update your kubeconfig with the cluster information
- Ensure thy kubeconfig has the configuration for the cluster you want to benchmark. You can use kubecdl to update thy kubeconfig with the cluster information
```console
$ kubecdl -p workspace-clusters [cluster-name]
$ kubectx [cluster-name]
Expand Down Expand Up @@ -50,7 +50,7 @@ In order to configure the benchmark, you can use the configuration file
| repo.environment | Environment variables that will only be set for this repository |
| repo.workspaceClass | The workspace class to use for the workspace that will be created for this repository |

After the benchmark has completed, you will find a benchmark-result.json file in your working directory, that contains information about every started workspace.
After the benchmark has completed, you will find a benchmark-result.json file in thy working directory, that contains information about every started workspace.

```
[
Expand Down
2 changes: 1 addition & 1 deletion install/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Download the licenses below:
#### Existing Cluster

1. Ensure you meet all of the requirements listed [here](https://www.gitpod.io/docs/self-hosted/latest/requirements)
2. Additionally, you will need to have `cert-manager` installed in your existing Kubernetes cluster. If not installed already, instructions on how to do so can be found [here](https://cert-manager.io/docs/installation/)
2. Additionally, you will need to have `cert-manager` installed in thy existing Kubernetes cluster. If not installed already, instructions on how to do so can be found [here](https://cert-manager.io/docs/installation/)
3. Then run:

```shell
Expand Down
16 changes: 8 additions & 8 deletions install/infra/single-cluster/aws/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ This module will do the following steps:
- Set up external-dns using our [`external-dns` module](../../modules/tools/external-dns/)
- Creates a cluster-issuer using our [`issuer` module](../../modules/tools/issuer/)

> 💡 If you would like to create the infrastructure orchestrating the terraform modules by yourself, you can find all the modules we support [here](../../modules/).
> 💡 If you would like to create the infrastructure orchestrating the terraform modules by thyself, you can find all the modules we support [here](../../modules/).

Since the entire setup requires more than one terraform target to be run due to
dependencies (eg: helm provider depends on kubernetes cluster config, which is
Expand All @@ -37,7 +37,7 @@ Before starting the installation process, you need:
* Setup credentials to be usable in one of the following ways:
* [As environmental variables](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-envvars.html)
* Copy the file `.env_sample` to `.env` and update the values corresponding
to your AWS user. Run:
to thy AWS user. Run:
```sh
source .env
```
Expand Down Expand Up @@ -146,12 +146,12 @@ make output
Once the apply process has exited successfully, we can go ahead and prepare to
setup Gitpod. If you specified the `domain_name` in the `terraform.tfvars` file,
the terraform module registers the module with `route53` to point to the
cluster. Now you have to configure whichever provider you use to host your
cluster. Now you have to configure whichever provider you use to host thy
domain name to route traffic to the AWS name servers. You can find these name
servers in the `make output` command from above. It would be of the format:

```json
Nameservers for the domain(to be added as NS records in your domain provider):
Nameservers for the domain(to be added as NS records in thy domain provider):
=================
[
"ns-1444.awsdns-52.org.",
Expand All @@ -161,8 +161,8 @@ Nameservers for the domain(to be added as NS records in your domain provider):
]
```

Add the `ns` records similar to the above 4 URIs as NS records under your domain
DNS management setup. Check with your domain hosting service for specific information.
Add the `ns` records similar to the above 4 URIs as NS records under thy domain
DNS management setup. Check with thy domain hosting service for specific information.

## Note the dependency credentials from terraform output

Expand Down Expand Up @@ -212,7 +212,7 @@ NAME READY STATUS RESTARTS AGE
proxy-5998488f4c-t8vkh 0/1 Init 0/1 0 5m
```

The most likely reason is that the DNS01 challenge has yet to resolve. To fix this, make sure you have added the NS records corresponding to the `route53` zone of the `domain_name` added to your domain provider.
The most likely reason is that the DNS01 challenge has yet to resolve. To fix this, make sure you have added the NS records corresponding to the `route53` zone of the `domain_name` added to thy domain provider.

Once the DNS record has been updated, you will need to delete all Cert Manager pods to retrigger the certificate request

Expand All @@ -230,7 +230,7 @@ https-certificates True https-certificates 5m

### Cannot connect to the created cluster after a while

There is a chance that your kubeconfig has gotten expired after a specific amount of time. You can reconnect to the cluster by using:
There is a chance that thy kubeconfig has gotten expired after a specific amount of time. You can reconnect to the cluster by using:

``` sh
aws eks --region <regon> update-kubeconfig --name <cluster_name>
Expand Down
Loading