Skip to content

Commit 1b5b5e8

Browse files
nermillerrrelledge
andauthored
Apply suggestions from code review
Co-authored-by: Rachel Elledge <[email protected]>
1 parent f00a7a2 commit 1b5b5e8

File tree

9 files changed

+38
-32
lines changed

9 files changed

+38
-32
lines changed

docs/ui/insight/plugins/plugin-development.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ To use the plugin, the `package.json` file must include these required fields:
5050
<br><br>
5151
Required fields in visualizations:
5252
<ul>
53-
<li><code>id</code>: Visualization id</li>
53+
<li><code>id</code>: Visualization ID</li>
5454
<li><code>name</code>: Visualization name to display in <b>Workbench</b></li>
5555
<li><code>activationMethod</code>: Name of the exported function to call when
5656
this visualization is selected in the Workbench</li>
@@ -63,7 +63,7 @@ this visualization is selected in the Workbench</li>
6363
</tr>
6464
</table>
6565

66-
You can specify the path to a css file in the `styles` field. If specified,
66+
You can specify the path to a CSS file in the `styles` field. If specified,
6767
this file will be included inside the IFrame plugin.
6868

6969
Simple example of the `package.json` file with required and optional fields:
@@ -100,10 +100,10 @@ Simple example of the `package.json` file with required and optional fields:
100100

101101
## Core script of the plugin
102102

103-
The core (required) script contains function and its export (functions, for multiple visualizations).
104-
The script is run after the relevant visualization is selected in **Workbench**.
103+
The core (required) script contains a function and its export (functions, for multiple visualizations).
104+
The script runs after the relevant visualization is selected in **Workbench**.
105105

106-
The following function receives props of the executed commands:
106+
The following function receives `Props` of the executed commands:
107107

108108
```typescript
109109
interface Props {
@@ -123,12 +123,12 @@ const renderVisualization = (props: Props) => {
123123
export default { renderVisualization }
124124
```
125125

126-
Each plugin iframe has basic styles of RedisInsight application, including fonts and color schemes.
126+
Each plugin iframe has basic styles that match the RedisInsight application, including fonts and color schemes.
127127

128128
It is recommended to use the React & [Elastic UI library](https://elastic.github.io/eui/#/) for
129129
consistency with plugin visualizations and the entire application.
130130

131-
Find the example of the plugin here.
131+
For a plugin example, see:
132132

133133
* [Client List Plugin README](https://github.com/RedisInsight/Packages/blob/main/clients-list-example/README.md)
134134
* [Client List Plugin dir](https://github.com/RedisInsight/Packages/blob/main/clients-list-example/)
@@ -149,11 +149,11 @@ const { baseUrl, appVersion } = config
149149

150150
### Plugin rendering
151151

152-
To render the plugin visualization, the iframe with basic html is generated which is
153-
then populated with relevant scripts and styles. To render the html data, use existing
154-
DOM Element `#app` or create your own DOM Elements.
152+
To render the plugin visualization, the iframe with basic HTML is generated and
153+
then populated with relevant scripts and styles. To render the HTML data, use the existing
154+
DOM element `#app` or create your own DOM elements.
155155

156-
The rendered iframe also includes `theme_DARK` or `theme_LIGHT` className on `body` to indicate the application theme used.
156+
The rendered iframe also includes `theme_DARK` or `theme_LIGHT` `className` on `body` to indicate the application theme used.
157157

158158
**JavaScript**
159159

@@ -199,4 +199,4 @@ export default { renderVisualization }
199199
Use the [redisinsight-plugin-sdk](https://www.npmjs.com/package/redisinsight-plugin-sdk), which is a third party library,
200200
to communicate with the main app.
201201

202-
Find the list and description of methods called in the [README.md](https://github.com/RedisInsight/RedisInsight/blob/main/redisinsight/ui/src/packages/clients-list/README.md).
202+
For a list of methods and their descriptions, see the [README.md](https://github.com/RedisInsight/RedisInsight/blob/main/redisinsight/ui/src/packages/clients-list/README.md).

docs/ui/insight/plugins/plugin-installation.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ aliases:
88

99
{{% alert title="Note" color="warning" %}}
1010

11-
To avoid automatic execution of malicious code, when adding new plugins for Workbench, use files from trusted authors only.
11+
To avoid automatic execution of malicious code when adding new Workbench plugins, use files from trusted authors only.
1212

1313
{{% /alert %}}
1414

@@ -17,10 +17,10 @@ To avoid automatic execution of malicious code, when adding new plugins for Work
1717
* For MacOS: `<usersHomeDir>/.redisinsight-preview/plugins`
1818
* For Windows: `C:/Users/{Username}/.redisinsight-preview/plugins`
1919
* For Linux: `<usersHomeDir>/.redisinsight-preview/plugins`
20-
1. Add the folder with plugin to the `plugins` folder.
20+
1. Add the folder that contains the plugin to the `plugins` folder.
2121

2222
To see the uploaded plugin visualizations in the command results, reload the Workbench
23-
page and run Redis command relevant for this visualization.
23+
page and run the relevant Redis command.
2424

2525
## Usage
2626

@@ -31,4 +31,4 @@ To see command results in the uploaded plugin visualization:
3131
1. Open the database.
3232
1. Open **Workbench**.
3333
1. Run the Redis command for the plugin visualization.
34-
1. Select the plugin visualization in which to display results, if this visualization has not been set by default.
34+
1. Select the plugin visualization to use if this visualization was not set by default.

docs/ui/insight/tools/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,4 @@ weight: 30
66

77
---
88

9-
RedisInsight makes it easy to query, visualize, and interactively work with Redis capabilities. Whether using Redis Stack, Redis Enterprise, or Redis Enterprise Cloud, RedisInsight allows you to manipulate complex data models such as documents, graphs, and time series. Explore queryable JSON documents, full-text search, probabilistic data structures, and more.
9+
RedisInsight makes it easy to query, visualize, and interactively work with Redis capabilities. Whether using Redis Stack, Redis Enterprise Software, or Redis Enterprise Cloud, RedisInsight allows you to manipulate complex data models such as documents, graphs, and time series. Explore queryable JSON documents, full-text search, probabilistic data structures, and more.

docs/ui/insight/tools/browser.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ weight: 10
66

77
---
88

9-
**Browser** offers [CRUD](https://en.wikipedia.org/wiki/Create,_read,_update_and_delete) support for lists, hashes, strings, sets, sorted sets, streams, as well as for [RedisJSON](/docs/stack/json).
9+
**Browser** offers [CRUD](https://en.wikipedia.org/wiki/Create,_read,_update_and_delete) support for lists, hashes, strings, sets, sorted sets, streams, and [RedisJSON](/docs/stack/json).
1010

1111
* Browse, filter, and visualize your key-value Redis data structures.
1212

docs/ui/insight/tools/bulk-actions.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,15 @@ weight: 10
66
aliases:
77
---
88

9-
Easily and quickly delete multiple keys of the same type and/or with the same key name pattern in bulk. To do so, in the List or Tree view, set filters per key type or key names and open the Bulk Actions section. The section displays a summary of all the keys with the expected number of keys that will be deleted based on the set filters.
9+
With bulk actions, you can delete multiple keys with the same type, the same key name pattern, or both in bulk.
10+
11+
To delete multiple keys in bulk:
12+
13+
1. In the List or Tree view, filter by key type or key name.
14+
15+
1. Select **Bulk Actions** to display the keys and the expected number of keys to be deleted based on the configured filters.
16+
17+
1. Select **Delete**.
1018

1119
When the bulk deletion is completed, RedisInsight displays the results of this operation with the number of keys processed and the time taken to delete the keys in bulk.
1220
Use bulk deletion to optimize the usage of your database based on the results from the Redis database analysis.

docs/ui/insight/tools/cli.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ weight: 10
99
The CLI is accessible at any time within the application. It includes:
1010

1111
* Type-ahead help.
12-
* A command helper that lets you filter and search.
12+
* A command helper that lets you filter and search commands.
1313

1414
Try executing Redis commands as shown here.
1515

docs/ui/insight/tools/connection-management.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ weight: 10
77

88
---
99

10-
* Automatically discover and add your local Redis or Redis Stack databases (that use standalone connection type and do not require authentication).
11-
* Discover your databases in Redis Enterprise Cluster and databases with Flexible plans in Redis Cloud.
12-
* Use a form to enter your connection details and add any Redis database running anywhere (including OSS Cluster, Sentinel).
10+
* Automatically discover and add your local Redis or Redis Stack databases (that use the standalone connection type and do not require authentication).
11+
* Discover your databases in Redis Enterprise Software and databases with Flexible plans in Redis Cloud.
12+
* Use a form to enter your connection details and add any Redis database running anywhere (including OSS Cluster and Sentinel).
1313

1414
<img src="../../images/Databases.png">

docs/ui/insight/tools/database-analysis.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ aliases:
88

99
Use the **Database Analysis** tool to optimize the performance and memory usage of your Redis database. Check data type distribution and memory allocation and review the summary of key expiration time and memory to be freed over time. Inspect the top keys and namespaces sorted by consumed memory or key length and count of keys, respectively. Capture and track the changes in your database by viewing historical analysis reports.
1010

11-
Next figure shows a sample database analysis report.
11+
The following image shows a sample database analysis report.
1212

1313
<img src="../../images/database_analysis.png">
1414

@@ -22,9 +22,9 @@ Recommendations are generated specifically for your Redis or Redis Stack databas
2222

2323
<img src="../../images/database_recommendations.png">
2424

25-
## Optimizing your database memory and performance
25+
## Optimize database memory and performance
2626

27-
While investigating ways to optimize memory and performance, or inspecting cases when you noticed high memory usage in your Redis or Redis Stack database, you may need to find the biggest keys or most memory-intensive data structures, or to analyze the allocation of data structures and compare it with previous intervals.
27+
While investigating ways to optimize memory and performance or inspecting high memory usage in your Redis or Redis Stack database, you may need to find the biggest keys or most memory-intensive data structures or analyze the allocation of data structures and compare it with previous intervals.
2828

2929
The **Database analysis** tool can help you to:
3030

@@ -35,22 +35,20 @@ The **Database analysis** tool can help you to:
3535

3636
After you launch RedisInsight following [Get started](/docs/ui/insight/get-started):
3737

38-
* Add your Redis database instance or create a new and free cloud database.
38+
* Add your Redis database instance or create a new, free Redis Enterprise Cloud database.
3939
* To test the features, open the database. Then, go to **Analysis tools > Database Analysis** and generate a new report.
4040

4141
RedisInsight automatically analyzes up to 10,000 keys in your database and generates a report with diagrams that contains a summary of your database.
4242

43-
## Reviewing Database analysis report
43+
## Review database analysis report
4444

4545
Next diagram contains information about memory allocation and the number of keys per data structure in your Redis or Redis Stack database. You get an overview of the most popular and memory-intensive data structures.
4646

4747
<img src="../../images/memory-allocation.png">
4848

49-
And the next diagram summarizes the expiration time in your database. Observe the amount of memory to be freed over time.
49+
The next diagram summarizes the expiration time in your database and the amount of memory to be freed over time.
5050

5151
To optimize memory usage, configure the expiration time to allow Redis to automatically remove keys that are no longer needed. Setting the expiration time is useful for cache invalidation, because cached data is refreshed periodically to avoid stale data and keep the cache up to date.
5252

5353
<img src="../../images/expiration-time.png">
5454

55-
The **Database analysis** tool also gives you an overview of existing keys and namespaces used so you can find the biggest keys or the most memory-intensive or used namespaces in your database.
56-
RedisInsight also helps you capture and track changes in your database by providing historical analysis reports.

docs/ui/insight/tools/slow-log.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Slow Log
33
linkTitle: Slow Log
4-
description: Display logs captured by SLOWLOG command
4+
description: Display logs captured by the SLOWLOG command
55
weight: 10
66

77
---

0 commit comments

Comments
 (0)