From 062a41d2f559a21b24537cd040de9d625dbfda01 Mon Sep 17 00:00:00 2001 From: malcolmholmes <42545407+malcolmholmes@users.noreply.github.com> Date: Wed, 14 Aug 2024 20:26:45 +0100 Subject: [PATCH] Minor doc tweaks (#476) --- docs/content/server.md | 6 ++++++ docs/content/what-is-grizzly.md | 15 +++++++++++---- 2 files changed, 17 insertions(+), 4 deletions(-) diff --git a/docs/content/server.md b/docs/content/server.md index 60f46475..40d4e824 100644 --- a/docs/content/server.md +++ b/docs/content/server.md @@ -69,6 +69,7 @@ render your dashboard(s) to files. One such tool is [entr](https://github.com/er used like so (with the Foundation SDK's TypeScript support): ``` +git clone https://github.com/grafana/grafana-foundation-sdk cd grafana-foundation-sdk/examples/typescript/red-method npm install find . | entr -s 'npm run -s dev > ts.json' @@ -77,3 +78,8 @@ Then, in another window: ``` grr serve -w ts.json ``` +Finally, open the Grizzly server at [http://localhost:8080](http://localhost:8080) and select the Red +Method dashboard. + +Now, any changes to any of the Typescript files for the example Red Method dashboard will be instantly +shown in your dashboard. \ No newline at end of file diff --git a/docs/content/what-is-grizzly.md b/docs/content/what-is-grizzly.md index 52137987..15efbde0 100644 --- a/docs/content/what-is-grizzly.md +++ b/docs/content/what-is-grizzly.md @@ -19,10 +19,17 @@ descriptions. (Programmatic description is explained in the section on We will first explore how to use Grizzly with Grafana. ## Authentication -You will need to set at least the `GRAFANA_URL` environment variable. This should -be to the root of your Grafana instance. If your Grafana instance requires authentication, -then you are recommended to acquire an API key (`Configuration` / `API keys`). Set the -`GRAFANA_TOKEN` to this value. For more this, see [authentication](../authentication/). +To work with Grafana, you will need to give Grafana credentials for your instance. The +recommended way to do this would be to create a "context", and set the Grafana URL and a +service account token. Here we create an "instance" context: + +``` +grr config create-context instance +grr config set grafana.url http://localhost:3000 +grr config set grafana.token +``` + +For further explanations and other options, see [authentication](../authentication/). ## Managing a Simple Dashboard