Skip to content

Commit

Permalink
Clarify additional YAMLs in local setup documentation. (#317)
Browse files Browse the repository at this point in the history
  • Loading branch information
jeschkies authored Jun 13, 2024
1 parent b92f4a6 commit 9303f0a
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/local-development.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Let's break down what each of these files is for:
| File | Purpose |
|------|---------|
| `Tiltfile` | Tiltfile written in [Starlark](https://github.com/bazelbuild/starlark). This configures Tilt. |
| `additional/` | Directory containing user-generated and source-controlled kubernetes YAML files to play on top of the generated ones. |
| `additional/` | Directory containing user-generated and source-controlled kubernetes YAML files to apply alongside the generated ones. |
| `config.yaml` | Configuration file for the `grafana-app-sdk` CLI to use when generating kubernetes manifests and the K3D config. |
| `mounted-files/` | Everything in here gets mounted in the K3D cluster. `mounted-files/plugin` is where the built plugin should be placed to be properly mounted in the grafana instance. |
| `scripts/cluster.sh` | K3D cluster control scripts. |
Expand Down Expand Up @@ -177,4 +177,4 @@ You can access logs for all your deployments via the Tilt UI as well.

## Making Changes

Any changes you make are automatically picked up by Tilt while your local deployment is running. If you make changes to the plugin, just re-deploy the plugin (either with the make target or manually), and they should be present. For operator changes, push the new operator image, and restart the operator deployment (you can do this from the Tilt UI) to get the changes deployed.
Any changes you make are automatically picked up by Tilt while your local deployment is running. If you make changes to the plugin, just re-deploy the plugin (either with the make target or manually), and they should be present. For operator changes, push the new operator image, and restart the operator deployment (you can do this from the Tilt UI) to get the changes deployed.

0 comments on commit 9303f0a

Please sign in to comment.