Skip to content

Commit

Permalink
Merge pull request #54 from grafana/malcolmholmes/sammyj-readme-comments
Browse files Browse the repository at this point in the history
Readme tweaks
  • Loading branch information
malcolmholmes authored Nov 6, 2023
2 parents ad66a61 + 66bcc0d commit 0b2c37b
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 8 deletions.
18 changes: 11 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,13 +34,17 @@ This extension gives you support for Git (and any other version control system f
1. Select the Extensions icon (![extensions icon](./public/extensions-icon.png)) on the left bar in VSCode.
2. Enter `Grafana` into the search box. Select the option for `Grafana / Grafana Editor` and click `Install`.
3. Open the Settings tab inside the extension (CTRL+, (comma) or `cmd` + `,` on Mac) and search for `grafana`. Then select `Extensions`.
4. Provide the default URL for your Grafana instance in the `URL` field. If you are using a local Grafana instance, the default value is `http://localhost:3000`.
5. Create a [Service account in Grafana](https://grafana.com/docs/grafana/latest/administration/service-accounts/#create-a-service-account-in-grafana) and add a token to it.
6. In the VS Code settings, click `Set your token, securely` then paste your token into the popup. Press ENTER.
7. Open a folder on your computer that has some dashboard JSON (if you don't have any of your own, navigate to the `dashboards` folder of this repo).
8. Right-click on a dashboard JSON file and select `Edit in Grafana`.
9. Have fun!
10. Note, clicking `save` on your dashboard will update the JSON file in your local folder.

### Configure the Extension
1. Provide the default URL for your Grafana instance in the `URL` field. If you are using a local Grafana instance, the default value is `http://localhost:3000`.
2. Create a [Service account in Grafana](https://grafana.com/docs/grafana/latest/administration/service-accounts/#create-a-service-account-in-grafana) and add a token to it.
3. In the VS Code settings, click `Set your token, securely` then paste your token into the popup. Press ENTER.

### Using the Extension
1. Open a folder on your computer that has some dashboard JSON (if you don't have any of your own, navigate to the `dashboards` folder of [this repo](https://github.com/grafana/grafana-vs-code-extension/tree/main/dashboards)).
2. Right-click on a dashboard JSON file in the file explorer and select `Edit in Grafana`.
3. Have fun!
4. Note, clicking `save` on your dashboard will update the JSON file in your local folder.

### Run from Repository
1. If using local Grafana, start Grafana locally or via Docker.
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"displayName": "Grafana",
"description": "Grafana Editor",
"icon": "public/grafana_icon.png",
"version": "0.0.9",
"version": "0.0.10",
"license": "Apache-2.0",
"repository": {
"type": "git",
Expand Down

0 comments on commit 0b2c37b

Please sign in to comment.