Update README and CHANGELOG (#59)

Author: mikhail-vl

CHANGELOG.md

@@ -1,10 +1,20 @@
 # Change Log
 
-## 1.2.0 (IN PROGRESS)
+## 1.2.0 (2021-05-11)
 
 ### Features / Enhancements
 
-- Update Grafana dependencies to 7.5.4
+- Upgrade Grafana dependencies 7.5.4 #53
+- Update Docker workflow #52
+- Update Docker token and add Master build #54
+- Add RefId to Query as mandatory for the upcoming release #55
+- Update RedisGears Script Editor Execution modes #57
+- Update Dashboards to version 7.5.5 #58
+
+### Bug fixes
+
+- Add default Color Mode Id for older releases (7.2.X) #49
+- Fix Latency below zero calculation #56
 
 ## v1.1.0 (2021-02-07)
 

README.md

@@ -8,124 +8,74 @@
 ![CI](https://github.com/RedisGrafana/grafana-redis-app/workflows/CI/badge.svg)
 ![Docker](https://github.com/RedisGrafana/grafana-redis-app/workflows/Docker/badge.svg)
 [![codecov](https://codecov.io/gh/RedisGrafana/grafana-redis-app/branch/master/graph/badge.svg?token=15SIRGU8SX)](https://codecov.io/gh/RedisGrafana/grafana-redis-app)
+[![Language grade: JavaScript](https://img.shields.io/lgtm/grade/javascript/g/RedisGrafana/grafana-redis-app.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/RedisGrafana/grafana-redis-app/context:javascript)
 
 ## Summary
 
 - [**Introduction**](#introduction)
-- [**Dashboards**](#dashboards)
-- [**Custom panels**](#custom-panels)
 - [**Getting Started**](#getting-started)
+- [**Documentation**](#documentation)
+- [**Development**](#development)
 - [**Feedback**](#feedback)
 - [**Contributing**](#contributing)
 - [**License**](#license)
 
 ## Introduction
 
-### What is the Redis Application for Grafana?
+The Redis Application is a plug-in for Grafana that provides application pages, custom panels, and dashboards for [Redis Data Source](https://grafana.com/grafana/plugins/redis-datasource).
 
-The Redis Application, is a plug-in for Grafana that provides application pages and custom panels for [Redis Data Source](https://grafana.com/grafana/plugins/redis-datasource):
+### Custom Panels
 
-- [**Command line interface (CLI)**](#redis-cli-panel)
-- [**Command Latency (graph and table)**](#latency-panel)
-- [**Keys consuming a lot of memory**](#keys-consuming-a-lot-of-memory-panel)
-- [**Redis Gears**](#redis-gears-panel)
+- [Command-line interface (CLI)](https://redisgrafana.github.io/redis-app/panels/redis-cli-panel/)
+- [Command Latency (graph and table)](https://redisgrafana.github.io/redis-app/panels/redis-latency-panel/)
+- [Keys consuming a lot of memory](https://redisgrafana.github.io/redis-app/panels/redis-keys-panel/)
+- [RedisGears Script Editor](https://redisgrafana.github.io/redis-app/panels/redis-gears-panel/)
 
-### What Grafana version is supported?
+### Dashboards
 
-Only Grafana 7.1 and later with a new plug-in platform supported.
+- [Redis CLI](https://redisgrafana.github.io/redis-app/dashboards/cli/)
+- [Redis Overview](https://redisgrafana.github.io/redis-app/dashboards/overview/)
+- [RedisGears](https://redisgrafana.github.io/redis-app/dashboards/redis-gears/)
 
-## Dashboards
-
-Redis application plug-in includes Redis Overview, CLI and RedisGears dashboards. All dashboard are available from Application's icon in the left side menu.
+All dashboards are available from the application's icon in the left side menu.
 
 ![Redis-CLI-Dashboards](https://raw.githubusercontent.com/RedisGrafana/grafana-redis-app/master/src/img/redis-cli-dashboard.png)
 
-Redis CLI dashboard combines Redis CLI with streaming panels to observe Redis database in real-time.
-
-## Custom Panels
-
-## Redis CLI panel
-
-This panel provides [Redis command line interface](https://redis.io/topics/rediscli) that allows to send commands to Redis, and read the replies sent by the server, directly from the Grafana.
-
-![CLI](https://raw.githubusercontent.com/RedisGrafana/grafana-redis-app/master/src/img/redis-cli-panel.png)
-
-## Latency panel
-
-Redis is often used in the context of demanding use cases, where it serves a large number of queries per second per instance, and at the same time, there are very strict latency requirements both for the average response time and for the worst case latency.
-
-![Latency-Graph](https://raw.githubusercontent.com/RedisGrafana/grafana-redis-app/master/src/img/redis-latency-panel-graph.png)
-
-This panel provides commands's latency based on [INFO COMMANDSTATS](https://redis.io/commands/info). Information is provide as chart and table.
-
-![Latency-Table](https://raw.githubusercontent.com/RedisGrafana/grafana-redis-app/master/src/img/redis-latency-panel-table.png)
-
-## Keys consuming a lot of memory panel
-
-Do you want to know which keys consume a lot of memory in your Redis database? This panel is based on [SCAN](https://redis.io/commands/scan) and [MEMORY USAGE](https://redis.io/commands/memory-usage) commands to scan keys and sort results based on memory usage in the table format.
-
-![Keys](https://raw.githubusercontent.com/RedisGrafana/grafana-redis-app/master/src/img/redis-keys-panel.png)
-
-Please use this command in OFF-PEAK as it cause latency increase. Interval and count for SCAN command is configurable to keep latency under control.
-
-## Redis Gears panel
+### Requirements
 
-[RedisGears](https://oss.redislabs.com/redisgears/) is a dynamic framework that enables developers to write and execute functions that implement data flows in Redis, while abstracting away the data’s distribution and deployment. This panel support Python syntax and allows to execute functions in blocking and non-blocking mode.
-
-![RedisGears-Dashboard](https://raw.githubusercontent.com/RedisGrafana/grafana-redis-app/master/src/img/redis-gears-dashboard.png)
+Only **Grafana 7.1+** with a new Backend plug-in platform supports Redis plug-ins.
 
 ## Getting Started
 
-### Install using `grafana-cli`
-
-Use the `grafana-cli` tool to install from the commandline:
+Use the `grafana-cli` tool to install from the command line:
 
 ```bash
 grafana-cli plugins install redis-app
 ```
 
-### Run using `docker`
-
-```bash
-docker run -d -p 3000:3000 --name=grafana -e "GF_INSTALL_PLUGINS=redis-app" grafana/grafana
-```
-
-### Run using `docker` the nightly build (UNSTABLE)
-
-Supported platforms are:
-
-- linux/amd64
-- linux/arm64
-- linux/arm
+For Docker instructions and installation without Internet access, follow the [Quickstart](https://redisgrafana.github.io/quickstart/) page.
 
-```bash
-docker run -d -p 3000:3000 --name=redis-app ghcr.io/redisgrafana/redis-app:latest
-```
+### Open Grafana and enable Redis Application plug-in
 
-### Run using `docker-compose` for development
+Open Grafana in your browser, enable Redis Application plug-in, and configure Redis Data Sources.
 
-Application plug-in and Redis Data Source have to be built following [BUILD](https://github.com/RedisGrafana/grafana-redis-app/blob/master/BUILD.md) instructions before starting.
+![Enable](https://raw.githubusercontent.com/RedisGrafana/grafana-redis-app/master/src/img/enable.png)
 
-Project provides `docker-compose/dev.yml` to start Redis with Redis Labs modules and Grafana 7.0.
+## Documentation
 
-```bash
-docker-compose -f docker-compose/dev.yml up
-```
-
-### Open Grafana and enable Redis Application plug-in
+Take a look at the [Documentation](https://redisgrafana.github.io/redis-app/overview/) to learn more about the Redis Application plug-in, Redis Data Source, provided dashboards, and custom panels.
 
-Open Grafana in your browser, enable Redis Application plug-in and configure Redis Data Sources.
+## Development
 
-## Learn more
+[Developing Redis Application plug-in](https://redisgrafana.github.io/development/redis-app/) page provides instructions on building the application.
 
-- [Real-time observability with Redis and Grafana](https://grafana.com/go/observabilitycon/real-time-observability-with-redis-and-grafana/)
-- [Redis Data Source](https://grafana.com/grafana/plugins/redis-datasource)
+Are you interested in the latest features and updates? Start nightly built [Docker image for Redis Application plug-in](https://redisgrafana.github.io/development/images/).
 
 ## Feedback
 
-We love to hear from users, developers and the whole community interested by this plug-in. These are various ways to get in touch with us:
+We love to hear from users, developers, and the whole community interested in this plug-in. These are various ways to get in touch with us:
 
-- Ask a question, request a new feature and file a bug with [GitHub issues](https://github.com/RedisGrafana/grafana-redis-app/issues/new/choose).
+- Ask a question, request a new feature, and file a bug with [GitHub issues](https://github.com/RedisGrafana/grafana-redis-app/issues/new/choose).
 - Star the repository to show your support.
 
 ## Contributing