Skip to content

Commit

Permalink
Minor doc tweaks (#476)
Browse files Browse the repository at this point in the history
  • Loading branch information
malcolmholmes authored Aug 14, 2024
1 parent dccbf93 commit 062a41d
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 4 deletions.
6 changes: 6 additions & 0 deletions docs/content/server.md
Original file line number Diff line number Diff line change
Expand Up @@ -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'
Expand All @@ -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.
15 changes: 11 additions & 4 deletions docs/content/what-is-grizzly.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <my-service-account-token>
```

For further explanations and other options, see [authentication](../authentication/).

## Managing a Simple Dashboard

Expand Down

0 comments on commit 062a41d

Please sign in to comment.