diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index ef12074..af26e20 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -65,6 +65,8 @@ There are more details about processes and workflow in the [Maintainer's Guide]( ### Frontend +#### Starting the frontend + 1. Install dependencies ```bash @@ -89,6 +91,19 @@ There are more details about processes and workflow in the [Maintainer's Guide]( yarn build ``` +#### Proxying +Depending on your setup, it may be advantageous for you to setup a proxy from your +local machine to a KalDB query node running in a cloud environment. Below is +an example command to do that (NOTE: this may or may not work depending on +your setup): +``` +ssh -N -L $LOCALHOST_PORT:localhost:$REMOTE_PORT $NODE_NAME +``` + +You would then be able to use `host.docker.internal:$LOCALHOST_PORT` as the +KalDB datasource URL inside your Grafana instance. + + ### Backend 1. Update [Grafana plugin SDK for Go](https://grafana.com/docs/grafana/latest/developers/plugins/backend/grafana-plugin-sdk-for-go/) dependency to the latest minor version: