Update documentation

Author: marcusolsson

README.md

@@ -7,68 +7,10 @@
 [![License](https://img.shields.io/github/license/marcusolsson/grafana-json-datasource)](LICENSE)
 [![Twitter](https://img.shields.io/twitter/follow/marcusolsson?color=%231DA1F2&label=twitter&style=plastic)](https://twitter.com/marcusolsson)
 
-A data source plugin for loading JSON APIs into [Grafana](https://grafana.com).
+A data source plugin for loading JSON APIs into [Grafana](https://grafana.com) using [JSONPath](https://goessner.net/articles/JsonPath/).
 
 ![Screenshot](https://github.com/marcusolsson/grafana-json-datasource/raw/main/src/img/screenshot.png)
 
-Extract one or more values from a JSON API using [JSON Path](https://goessner.net/articles/JsonPath/). Each path results in a field in the query result. All fields need to be of the same length.
+## Documentation
 
-## Configuration
-
-This section lists the available configuration options for the JSON API data source.
-
-### Query editor
-
-| Configuration | Description |
-|---------------|-------------|
-| **Path** | Appends a URL path to the URL configured by the data source. |
-| **Query string** | Overrides the custom query parameters configured by the data source. |
-| **Cache Time** | Determines the time in seconds to save the API response. |
-| **Query** | Defines the [JSON Path](https://goessner.net/articles/JsonPath/) used to extract the field. |
-| **Type** | Defines the type of the values returned by the JSON Path query. |
-
-### Variables
-
-[Variables](https://grafana.com/docs/grafana/latest/variables) are supported for all text configuration options.
-
-### Macros
-
-Use macros in your query string and JSON Path queries to add dashboard context to your queries. Macros are available for the **Query string** and (JSON Path) **Query** options.
-| Macro | Description |
-|-------|-------------|
-| `$__unixEpochFrom()` | Start of the dashboard time interval as a Unix timestamp, i.e. 1494410783 |
-| `$__unixEpochTo()` | End of the dashboard time interval as a Unix timestamp, i.e. 1494410783 |
-
-## Public data sets
-
-Here are a few publicly available JSON data sets that you can try out.
-
-### Reddit
-
-Get information about any subreddit by adding `.json` at the end of the URL.
-
-#### Configuration
-
-- **URL:** `https://www.reddit.com/r/grafana.json`
-
-#### Sample queries
-
-- `$.data.children[*].data.title`
-- `$.data.children[*].data.created_utc`
-- `$.data.children[*].data.ups`
-
-### TVmaze
-
-List episodes from your favorite TV series.
-
-#### Configuration
-
-- **URL:** `http://api.tvmaze.com/singlesearch/shows`
-- **Query string:** `q=archer&embed=episodes`
-
-#### Sample queries
-
-- `$._embedded.episodes[*].name`
-- `$._embedded.episodes[*].airstamp`
-- `$._embedded.episodes[*].season`
-- `$._embedded.episodes[*].number`
+Full documentation for the plugin is available on the [website](https://marcusolsson.github.io/grafana-json-datasource).

website/docs/macros.md

@@ -0,0 +1,11 @@
+---
+id: macros
+title: Macros
+---
+
+Use macros to add dashboard context to your queries. Macros are available in HTTP params and JSONPath expressions.
+
+| Macro                | Description                                                               |
+|----------------------|---------------------------------------------------------------------------|
+| `$__unixEpochFrom()` | Start of the dashboard time interval as a Unix timestamp, i.e. 1494410783 |
+| `$__unixEpochTo()`   | End of the dashboard time interval as a Unix timestamp, i.e. 1494410783   |

website/docs/query-editor.md

@@ -55,12 +55,3 @@ Sets the text to send as a request body.
 - **Syntax highlighting** sets the active syntax for the editor. This is only for visual purposes and doesn't change the actual request.
 
 > **Note:** Due to limitations in modern browsers, Grafana ignores the request body if the HTTP method is set to GET.
-
-## Macros
-
-Use macros in your query string and JSON Path queries to add dashboard context to your queries.
-
-| Macro                | Description                                                               |
-|----------------------|---------------------------------------------------------------------------|
-| `$__unixEpochFrom()` | Start of the dashboard time interval as a Unix timestamp, i.e. 1494410783 |
-| `$__unixEpochTo()`   | End of the dashboard time interval as a Unix timestamp, i.e. 1494410783   |

website/docusaurus.config.js

@@ -1,7 +1,7 @@
 module.exports = {
   title: 'JSON API for Grafana',
   url: 'https://marcusolsson.github.io',
-  baseUrl: '/grafana-json-datasource/',
+  baseUrl: '/grafana-json-datasource',
   onBrokenLinks: 'throw',
   onBrokenMarkdownLinks: 'warn',
   favicon: 'img/favicon.ico',
@@ -83,7 +83,7 @@ module.exports = {
       {
         docs: {
           sidebarPath: require.resolve('./sidebars.js'),
-          editUrl: 'https://github.com/marcusolsson/grafana-json-datasource/edit/main/docs/',
+          editUrl: 'https://github.com/marcusolsson/grafana-json-datasource/edit/main/website/',
           routeBasePath: '/',
         },
         theme: {

website/sidebars.js

@@ -1,18 +1,18 @@
 module.exports = {
   someSidebar: [
     {
-      type: "doc",
-      id: "introduction",
+      type: 'doc',
+      id: 'introduction',
     },
     {
-      type: "category",
-      label: "Getting started",
-      items: ["installation", "configuration"],
+      type: 'category',
+      label: 'Getting started',
+      items: ['installation', 'configuration'],
     },
     {
-      type: "category",
-      label: "Basics",
-      items: ["query-editor"],
+      type: 'category',
+      label: 'Basics',
+      items: ['query-editor', 'macros'],
     },
   ],
 };