Docs website update (#401)

* docker file update

* license update

* docs website migration

* changelog update

* Update LICENSE

Co-authored-by: Zoltán Bedi <zoltan.bedi@gmail.com>

---------

Co-authored-by: Zoltán Bedi <zoltan.bedi@gmail.com>

Author: yesoreyeram

.github/workflows/docs.yml

@@ -1,8 +1,12 @@
 # Changelog
 
+## v1.3.10 - 2023-12-20
+
+- ⚙️ **Docs**: Documentation website moved from [github pages](https://grafana.github.io/grafana-json-datasource) to [grafana.com/docs/plugins](https://grafana.com/docs/plugins/marcusolsson-json-datasource/latest/) page
+
 ## v1.3.9 - 2023-11-21
 
-- Update configuration page to follow best practices
+- ⚙️ **Chore**: Update configuration page to follow best practices
 - ⚙️ **Chore**: Remove legacy form styles
 - ⚙️ **Chore**: Update readme and documentation
 - ⚙️ **Chore**: Added lint github workflow

CHANGELOG.md

@@ -28,18 +28,7 @@ After you've created the pull request:
 
 ## Contribute documentation
 
-This plugin uses [Docusaurus](https://docusaurus.io/) to build the [documentation](https://grafana.github.io/grafana-json-datasource).
-
-For more information about writing documentation using Docusaurus, refer to the [Docusaurus documentation](https://docusaurus.io/docs/).
-
-The individual documentation pages are written in Markdown. You can find them under [website/docs](website/docs).
-
-To preview the documentation site on your local machine, run the following in your terminal:
-
-```bash
-cd website/docs
-yarn start
-```
+The individual documentation pages are written in Markdown. You can find them under [docs/sources](./docs/sources/). Once documentation is updated, they will automatically published in [grafana.com/docs/plugins](https://grafana.com/docs/plugins/marcusolsson-json-datasource/latest/) website.
 
 ## Set up the project
 

CONTRIBUTING.md

@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright 2022 Grafana Labs
+   Copyright 2024 Grafana Labs
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

LICENSE

@@ -1,30 +1,24 @@
 # JSON API data source for Grafana
 
-[![Build](https://github.com/grafana/grafana-json-datasource/workflows/CI/badge.svg)](https://github.com/grafana/grafana-json-datasource/actions?query=workflow%3A%22CI%22)
-[![Release](https://github.com/grafana/grafana-json-datasource/workflows/Release/badge.svg)](https://github.com/grafana/grafana-json-datasource/actions?query=workflow%3ARelease)
-[![Marketplace](https://img.shields.io/badge/dynamic/json?logo=grafana&color=F47A20&label=marketplace&prefix=v&query=%24.items%5B%3F%28%40.slug%20%3D%3D%20%22marcusolsson-json-datasource%22%29%5D.version&url=https%3A%2F%2Fgrafana.com%2Fapi%2Fplugins)](https://grafana.com/grafana/plugins/marcusolsson-json-datasource)
-[![Downloads](https://img.shields.io/badge/dynamic/json?logo=grafana&color=F47A20&label=downloads&query=%24.items%5B%3F%28%40.slug%20%3D%3D%20%22marcusolsson-json-datasource%22%29%5D.downloads&url=https%3A%2F%2Fgrafana.com%2Fapi%2Fplugins)](https://grafana.com/grafana/plugins/marcusolsson-json-datasource)
-[![License](https://img.shields.io/github/license/grafana/grafana-json-datasource)](LICENSE)
-
 The Grafana JSON Datasource plugin empowers you to seamlessly integrate JSON data into Grafana. JSON is a versatile and widely used data format, and with this plugin, you can easily transform your JSON data into meaningful visualizations within Grafana dashboards.
 
 ## Documentation
 
-For comprehensive instructions on setting up and configuring the Grafana JSON API Datasource, please consult our official [documentation](https://grafana.github.io/grafana-json-datasource).
+For comprehensive instructions on setting up and configuring the Grafana JSON API Datasource, please consult our official [documentation](https://grafana.com/docs/plugins/marcusolsson-json-datasource/latest/).
 
 ## Contributing
 
 We welcome and appreciate contributions from the open-source community to make this project better. Whether you want to report a bug, request a new feature, or submit code changes, please follow the guidelines below:
 
-#### Reporting issues
+### Reporting issues
 
 If you encounter a bug or have a suggestion for improvement, please check our [issues](https://github.com/grafana/grafana-json-datasource/issues) to see if a similar issue has already been reported. If not, feel free to open a new issue. When creating an issue, please provide as much detail as possible, including the version of the datasource you are using, your version of grafana and steps to reproduce the issue.
 
-#### Requesting features
+### Requesting features
 
 If you have an idea for a new feature or enhancement, we encourage you to create an [issue](https://github.com/grafana/grafana-json-datasource/issues). This can help gather feedback and refine the proposal.
 
-#### Pull requests
+### Pull requests
 
 If you'd like to contribute code to this project, please follow these steps:
 

README.md

@@ -8,7 +8,7 @@ services:
       context: ./.config
       args:
         grafana_image: ${GRAFANA_IMAGE:-grafana-enterprise}
-        grafana_version: ${GRAFANA_VERSION:-10.0.3}
+        grafana_version: ${GRAFANA_VERSION:-main}
     ports:
       - 3000:3000/tcp
     volumes:

docker-compose.yaml

@@ -0,0 +1,24 @@
+---
+title: JSON API data source for Grafana
+menuTitle: JSON API data source
+description: This document introduces the JSON API data source
+aliases:
+keywords:
+  - data source
+  - json api
+labels:
+  products:
+    - oss
+    - grafana cloud
+weight: 100
+---
+
+JSON API is an open source data source plugin for Grafana that lets you visualize data from any URL that returns JSON, such as REST APIs or static file servers.
+
+## Known Limitations
+
+* Since the plugin doesn't keep a record of previous queries, each query needs to contain the complete data set you want to visualize. If you'd like to visualize how the data changes over time, you're probably better off storing the data in a database.
+
+* This plugin doesn't support backend operations such as alerting, recorded queries, public dashboards, enterprise query caching, etc. If you prefer to use one of those options, use the [Grafana Infinity Datasource plugin](https://grafana.com/grafana/plugins/yesoreyeram-infinity-datasource/) instead.
+
+* This plugins doesn't support authentication methods such as OAuth2, digest authentication, jwt authentication. If you prefer to use one of those options, use the [Grafana Infinity Datasource plugin](https://grafana.com/grafana/plugins/yesoreyeram-infinity-datasource/) instead.

website/static/img/annotation.png renamed to docs/images/annotation.png

@@ -1,15 +1,23 @@
 ---
-id: annotations
-title: Annotations
+title: Variables
+menuTitle: Variables
+description: This document explains the process of setting up variables using JSON API data source
+aliases:
+keywords:
+  - data source
+  - json api
+labels:
+  products:
+    - oss
+    - grafana cloud
+weight: 600
 ---
 
-![Annotations](../static/img/annotation.png)
+![Annotations](https://raw.githubusercontent.com/grafana/grafana-json-datasource/main/docs/images/annotation.png)
 
 [Annotations](https://grafana.com/docs/grafana/latest/dashboards/annotations) let you extract data from a data source and use it to annotate a dashboard.
 
-:::info
-Annotations support was added in **v1.0.1**. If you can't select the JSON API data source from the list of data sources, try updating to a more recent version.
-:::
+> **Info:** Annotations support was added in **v1.0.1**. If you can't select the JSON API data source from the list of data sources, try updating to a more recent version.
 
 To use the JSON API data source for annotations, follow the instructions on [Querying other data sources](https://grafana.com/docs/grafana/latest/dashboards/annotations/#querying-other-data-sources). Make sure to select the JSON API from the list of data sources.
 

website/static/img/editor-body.png renamed to docs/images/editor-body.png

@@ -1,6 +1,16 @@
 ---
-id: configuration
 title: Configuration
+menuTitle: Configuration
+description: This document explains the configuration process of JSON API data source
+aliases:
+keywords:
+  - data source
+  - json api
+labels:
+  products:
+    - oss
+    - grafana cloud
+weight: 300
 ---
 
 ## Add a JSON data source

website/static/img/editor-fields.png renamed to docs/images/editor-fields.png

@@ -0,0 +1,54 @@
+---
+title: Installation
+menuTitle: Installation
+description: This document explains the installation process of JSON API data source
+aliases:
+keywords:
+  - data source
+  - json api
+labels:
+  products:
+    - oss
+    - grafana cloud
+weight: 200
+---
+
+You can install the plugin using [grafana-cli](https://grafana.com/docs/grafana/latest/administration/cli/), or by downloading the plugin manually.
+
+## Install using grafana-cli
+
+To install the latest version of the plugin, run the following command on the Grafana server:
+
+In linux/macos, you can install the plugin using the following command
+
+```bash
+grafana-cli plugins install marcusolsson-json-datasource
+```
+
+whereas in windows machine, use the following command
+
+```bash
+grafana-cli.exe plugins install marcusolsson-json-datasource
+```
+
+## Install manually
+
+1. Go to [Releases](https://github.com/grafana/grafana-json-datasource/releases) on the GitHub project page
+2. Find the release you want to install
+3. Download the release by clicking the release asset called `marcusolsson-json-datasource-<version>.zip`. You may need to un-collapse the **Assets** section to see it.
+4. Unarchive the plugin into the Grafana plugins directory.
+
+   In linux/macos, you can use the following command to extract the plugin
+
+   ```bash
+   unzip marcusolsson-json-datasource-<version>.zip
+   mv marcusolsson-json-datasource /var/lib/grafana/plugins
+   ```
+
+   In windows, you can use the following command to extract the plugin
+
+   ```powershell
+   Expand-Archive -Path marcusolsson-json-datasource-<version>.zip -DestinationPath C:\grafana\data\plugins
+   ```
+
+5. Restart the Grafana server to load the plugin

website/static/img/editor-headers.png renamed to docs/images/editor-headers.png

@@ -1,6 +1,16 @@
 ---
-id: jsonata
 title: JSONata
+menuTitle: JSONata
+description: This document explains the jsonata usage in JSON API data source
+aliases:
+keywords:
+  - data source
+  - json api
+labels:
+  products:
+    - oss
+    - grafana cloud
+weight: 430
 ---
 
 [JSONata](https://docs.jsonata.org/) is a query and transformation language for JSON data.

website/static/img/editor-params.png renamed to docs/images/editor-params.png

@@ -1,6 +1,16 @@
 ---
-id: jsonpath
 title: JSONPath
+menuTitle: JSONPath
+description: This document explains the jsonpath usage in JSON API data source
+aliases:
+keywords:
+  - data source
+  - json api
+labels:
+  products:
+    - oss
+    - grafana cloud
+weight: 420
 ---
 
 [JSONPath](https://goessner.net/articles/JsonPath/) is a query language for JSON structures.
@@ -15,24 +25,18 @@ $.store.book[*].title
 - `.` selects a child of the current element
 - `*` selects all elements within an object or array
 
-:::note JSONPath Plus
-The JSON API data source uses the [JSONPath Plus](https://www.npmjs.com/package/jsonpath-plus) package to evaluate JSONPath expressions. JSONPath Plus extends the original specification with additional features.
-
-For more information on the supported syntax, refer to the [project page](https://github.com/JSONPath-Plus/JSONPath).
-:::
+> **Note:** The JSON API data source uses the [JSONPath Plus](https://www.npmjs.com/package/jsonpath-plus) package to evaluate JSONPath expressions. JSONPath Plus extends the original specification with additional features. For more information on the supported syntax, refer to the [project page](https://github.com/JSONPath-Plus/JSONPath).
 
 ## Filters
 
-:::note From version 1.3.4 filters are not supported anymore.
+> **Note:** From version 1.3.4 filters are not supported anymore.
 
 If your dashboards currently rely on JSONPath queries containing subexpressions, there are a few potential migration paths:
 
 1. For simple queries that use subexpressions for indexing/slicing, it may be possible to rewrite the query without a subexpressions for instance `[(@.length-1)]` can also be represented as `[:-1]`.
 2. For more complex queries, we suggest switching to the [`jsonata` language](http://docs.jsonata.org/simple), which the plugin also supports. This language has similar features to JSONPath, including support for filter expressions (called “predicates” in the documentation).
 3. If changing your existing queries isn’t feasible, the community plugin [“Infinity”](https://grafana.com/grafana/plugins/yesoreyeram-infinity-datasource/) supports JSONPath expressions, including filters and subexpressions if used with the `backend` parser option. Please note that Infinity is community supported plugin.
 
-:::
-
 Filters let you query elements based on a logical expression.
 
 For example, to query the titles of the books that cost more than 10:

website/static/img/editor-path.png renamed to docs/images/editor-path.png

@@ -1,6 +1,16 @@
 ---
-id: macros
 title: Macros
+menuTitle: Macros
+description: This document explains the macros provided by JSON API data source
+aliases:
+keywords:
+  - data source
+  - json api
+labels:
+  products:
+    - oss
+    - grafana cloud
+weight: 410
 ---
 
 Use macros to add dashboard context to your queries. Macros are available in HTTP params and JSONPath expressions.