Skip to content
Draft
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
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,3 +99,4 @@ To this end, we've developed a number of open source projects including:

We want to create a welcoming environment for everyone who is interested in contributing to Gitpod or participating in discussions with the Gitpod community.
This project has adopted the [Contributor Covenant Code of Conduct](https://github.com/gitpod-io/.github/blob/main/CODE_OF_CONDUCT.md), [version 2.0](https://www.contributor-covenant.org/version/2/0/code_of_conduct/).
Hello World
1 change: 1 addition & 0 deletions components/common-go/nsenter/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,3 +26,4 @@ Linux kernel namespace, you must `import` this library into a package if
you plan to use `libcontainer` directly. Otherwise Go will not execute
the `nsexec()` constructor, which means that the re-exec will not cause
the namespaces to be joined.
Hello World
1 change: 1 addition & 0 deletions components/dashboard/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,3 +105,4 @@ yarn test:integration:run
```

You should see Cypress running in the terminal.
Hello World
1 change: 1 addition & 0 deletions components/ee/agent-smith/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,3 +19,4 @@ Hint: do not use the `base64` to encode a signature
```
agent-smith signature new <signature-args> | agent-smith signature match <test-binary>
```
Hello World
1 change: 1 addition & 0 deletions components/gitpod-cli/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,3 +35,4 @@ If you would like to contribute to this component, check the [related GitHub iss
## Ownership

To know which Gitpod Team owns this component, check the [CODEOWNERS](https://github.com/gitpod-io/gitpod/blob/main/.github/CODEOWNERS).
Hello World
1 change: 1 addition & 0 deletions components/gitpod-db/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,3 +18,4 @@ When you are making changes to gitpod-protocol component, make sure to run `yarn
```
@inject(UserDB) protected readonly userDb: UserDB;
```
Hello World
1 change: 1 addition & 0 deletions components/gitpod-db/src/typeorm/migration/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,4 @@ leeway run components:update-license-header

Then, simply populate the `up` and `down` methods in the generated migration file.
(Hint: You can look at other migration files for inspiration.)
Hello World
1 change: 1 addition & 0 deletions components/ide-proxy/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,4 @@ IDE proxy is a simple Caddy application that currently only serve static files e
Attention: All files in the static folder should be immutable, if you need to change them you have to add new files and change the references

For example, to change the IDE logo you must upload a new file and change the `server-ide-config` configmap
Hello World
1 change: 1 addition & 0 deletions components/ide/jetbrains/backend-plugin/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,3 +43,4 @@ Listening for transport dt_socket at address: 54963
for now each thin client is accompanied by another window (main) which directly renders UI from backend. Sometimes
there are bugs when a file will be opened in this window instead of the thin client. It also can be that
the main window is not visible then try to find it in the left top corner and resize. It looks almost like a line.
Hello World
1 change: 1 addition & 0 deletions components/ide/jetbrains/gateway-plugin/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,3 +30,4 @@ This plugin is based on the [IntelliJ Platform Plugin Template](https://github.c
- Check if you can connect to a stopped workspace
- Check if changing the "Gitpod Host" in Preferences >> Tools >> Gitpod takes effect
- Check if the info displayed in the workspaces list is matching what you see on the Web App Dashboard
Hello World
1 change: 1 addition & 0 deletions components/image-builder-bob/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,3 +39,4 @@ BOB_BASE_REF=localhost:5000/source:latest BOB_TARGET_REF=localhost:5000/target:8
# debug using delve
BOB_BASE_REF=localhost:5000/source:latest BOB_TARGET_REF=localhost:5000/target:83 sudo -E $(which dlv) --listen=:2345 --headless=true --api-version=2 exec $(which bob) build
```
Hello World
1 change: 1 addition & 0 deletions components/local-app/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,3 +17,4 @@ docker run --rm -it -v /tmp/dest:/out eu.gcr.io/gitpod-core-dev/build/local-app:
cd components/local-app
BROWSER= GITPOD_HOST=<URL-of-your-preview-env> go run main.go --mock-keyring run
```
Hello World
1 change: 1 addition & 0 deletions components/openvsx-proxy/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
# OpenVSX Proxy

The OpenVSX proxy component stores frequently used requests to the OpenVSX registry and serves these requests in case the upstream OpenVSX registry is down.
Hello World
1 change: 1 addition & 0 deletions components/public-api-server/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,3 +27,4 @@ The roadmap and progress towards a stable release of the API is tracked in [Epic
* The API will be exposed on `api.gitpod.io` or `api.<domain>` for self-hosted or managed installations.
* The API is structured into services with definitions available in [components/public-api/gitpod/](../public-api/gitpod) as protobuf definitions.

Hello World
2 changes: 1 addition & 1 deletion components/public-api/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@
# Example Flows
This section gives examples how clients would use this API.

https://github.com/gitpod-io/gitpod/blob/094dde356a04740500175e8797462a48c3153c89/components/public-api/go/v1/examples_test.go#L20-L103
https://github.com/gitpod-io/gitpod/blob/094dde356a04740500175e8797462a48c3153c89/components/public-api/go/v1/examples_test.go#L20-L103Hello World
1 change: 1 addition & 0 deletions components/public-api/google/rpc/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,4 @@
This package contains type definitions for general RPC systems. While
[gRPC](https://github.com/grpc) is using these definitions, they
are not designed specifically to support gRPC.
Hello World
1 change: 1 addition & 0 deletions components/registry-facade/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,3 +12,4 @@ Registry-facade modifies images as they are downloaded. It consults with `ws-man
6. Desktop IDE

It also adds the `gp` cli to the workspace. Think of `registry-facade` as an image layer smuggler.
Hello World
1 change: 1 addition & 0 deletions components/registry-facade/ca-updater/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,4 @@ not possible to download updates or with restricted Internet access.

The container uses **Ubuntu** as base image due to [issues in alpine](https://github.com/gliderlabs/docker-alpine/issues/52)
to add custom CA certificates.
Hello World
1 change: 1 addition & 0 deletions components/server/src/bitbucket/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,3 +25,4 @@ test.only('Your cool test', function (done) {
//...
}
```
Hello World
2 changes: 1 addition & 1 deletion components/workspacekit/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@
![Architecture](../../docs/workspace/architecture.drawio.svg)

## Namespace layering
![Namespaces](../../docs/workspace/namespaces.drawio.svg)
![Namespaces](../../docs/workspace/namespaces.drawio.svg)Hello World
2 changes: 1 addition & 1 deletion components/ws-daemon/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,4 @@ JAEGER_ENDPOINT=http://localhost:14268/api/traces
JAEGER_SAMPLER_TYPE=const
# enable the constant sampler
JAEGER_SAMPLER_PARAM=1
```
```Hello World
2 changes: 1 addition & 1 deletion components/ws-daemon/shiftfs-module-loader/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ a Kubernetes cluster.

It heavily draws inspiration from:
https://github.com/falcosecurity/falco
https://github.com/toby63/shiftfs-dkms
https://github.com/toby63/shiftfs-dkmsHello World
1 change: 1 addition & 0 deletions components/ws-manager-api/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,4 @@ The ws-manager-api component hosts the api component of ws-manager.
## Making changes to the api
First, make sure those changes are really neccesary. We want to keep the interface as trim as possible.
To make changes, edit `core.proto` ideally in a backwards compatible manner. Then run `./generate.sh` in this directory to re-generate the GO and TypeScript protocol implementations.
Hello World
1 change: 1 addition & 0 deletions components/ws-manager/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,3 +39,4 @@ This EVT can be converted to testcases using `cd pkg/manager && go run testdata/
### Adding tests for Create Definite Workspace Pod
To create new testcases for the workspace pod creation part, one can convert a workspace request to a "start workspace context" required as input for such a test.
To do this, save a valid _workspace spec_ (e.g. `example-wsspec.json`) file as `pkg/manager/testdata/cdwp_MyCustomTestName.spec.json` and run the tests. The `TestCreateDefiniteWorkspacePod` test will convert those `cdwp_*.spec.json` files to the required test fixtures as `cdwp_*.json`.
Hello World
1 change: 1 addition & 0 deletions dev/addlicense/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,3 +30,4 @@ to single files.
Apache 2.0

This is not an official Google product.
Hello World
2 changes: 1 addition & 1 deletion dev/blowtorch/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,4 +25,4 @@ Flags:
-t, --toggle Help message for toggle

Use "blowtorch [command] --help" for more information about a command.
```
```Hello World
1 change: 1 addition & 0 deletions dev/loadgen/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,3 +74,4 @@ After the benchmark has completed, you will find a benchmark-result.json file in
},
...
```
Hello World
1 change: 1 addition & 0 deletions dev/manual-tests/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
# Manual Testing

This directory has [Ruruku](https://github.com/csweichel/ruruku) test plans for manual testing of Gitpod.
Hello World
1 change: 1 addition & 0 deletions dev/ssh-load-test/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,3 +65,4 @@ Testing in prev envs and test several cases:



Hello World
1 change: 1 addition & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,4 @@ The most up-to-date documentation can be found at https://www.gitpod.io/docs.
## Source

The docs content is hosted in the [gitpod-io/website](https://github.com/gitpod-io/website) repository, specifically in Markdown files located at https://github.com/gitpod-io/website/tree/main/gitpod/docs.
Hello World
1 change: 1 addition & 0 deletions install/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,3 +50,4 @@ For detailed instructions on the KOTS CLI, please see the [Replicated docs](http
## Installer

For advanced users, the [Installer](./installer) is available.
Hello World
1 change: 1 addition & 0 deletions install/infra/modules/aks/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,3 +95,4 @@ No modules.
| <a name="output_registry"></a> [registry](#output\_registry) | n/a |
| <a name="output_storage"></a> [storage](#output\_storage) | n/a |
<!-- END_TF_DOCS -->
Hello World
1 change: 1 addition & 0 deletions install/infra/modules/gke/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,3 +81,4 @@ terraform apply # provide the values that are prompted for
``` sh
terraform destroy
```
Hello World
1 change: 1 addition & 0 deletions install/infra/modules/k3s/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,3 +63,4 @@ You will find the `kubeconfig` populated to the path you specified or `./kubecon
```sh
terraform destroy
```
Hello World
1 change: 1 addition & 0 deletions install/infra/modules/tools/cert-manager/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,4 @@ This module is used in test setup, to deploy `cert-manager` and `external-dns`
on a created cluster, and to create a secret that the aforementioned deployments
can use to modify a `cloudDNS` record. This module works specifically for the
domain `gitpod-self-hosted.com`.
Hello World
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,4 @@ This module is used in test setup, to deploy `cert-manager` and `external-dns`
on a created cluster, and to create a secret that the aforementioned deployments
can use to modify a `cloudDNS` record. This module works specifically for the
domain `gitpod-self-hosted.com`.
Hello World
1 change: 1 addition & 0 deletions install/infra/single-cluster/aws/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -253,3 +253,4 @@ make destroy
```

The destroy should take around 20 minutes.
Hello World
1 change: 1 addition & 0 deletions install/infra/single-cluster/gcp/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -240,3 +240,4 @@ make destroy
```

The destroy should take around 20 minutes.
Hello World
1 change: 1 addition & 0 deletions install/installer/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -585,3 +585,4 @@ PRs/comments welcome

- [ ] [Improve distribution of gitpod-installer binaries](https://github.com/gitpod-io/gitpod/issues/6766)
- [ ] [Create a Gitpod workspace that can be used for installing a Gitpod instance](https://github.com/gitpod-io/gitpod/issues/6801)
Hello World
1 change: 1 addition & 0 deletions install/installer/cmd/testdata/render/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,3 +50,4 @@ Finally, generate your output:
```shell
make generateRenderTests
```
Hello World
1 change: 1 addition & 0 deletions install/installer/scripts/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,3 +28,4 @@ go run ./scripts/structdoc.go
INFO[0000] Generating doc for config version v1
INFO[0000] The doc is written to the file pkg/config/v1/config.md
```
Hello World
1 change: 1 addition & 0 deletions install/kots/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,3 +57,4 @@ is considered a release candidate. Once testing has passed, it is promoted to th

Promotion of releases from unstable to stable should be done in the management console on the
[Replicated vendor homepage](https://vendor.replicated.com/apps/gitpod).
Hello World
1 change: 1 addition & 0 deletions install/preview/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,3 +25,4 @@ As the `self-hosted` instance is self-signed, The root certificate to upload int
## Known Issues

- Prebuilds don't work as they require webhooks support over the internet.
Hello World
1 change: 1 addition & 0 deletions operations/observability/mixins/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -352,3 +352,4 @@ Please remember that the annotation `withObservabilityBranch` is completely opti
### Do I configure alerting routes in the mixin?

No, mixins only contains alerts definition. The routing is done by alertmanager, which is configured in another git repository.
Hello World
1 change: 1 addition & 0 deletions test/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,3 +70,4 @@ To run the tests:
-gitlab=<true|false>
```
3. If you want to run specific test, add `-run <test>` before `-kubeconfig` parameter.
Hello World