You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+92-35
Original file line number
Diff line number
Diff line change
@@ -1,10 +1,11 @@
1
1
## Introduction
2
-
Tutorials are documents that contain helpful use cases, comments and interesting experience about Redis and Redis Stack capabilities.
3
-
It is a perfect tool to present your use cases and experience using RedisInsight Workbench and share them with others!
4
2
5
-
This page provides an overview of the Tutorials structure, its elements and contains instructions, recommendations, and best practices for updating and sharing Tutorials.
3
+
Tutorials are interactive documents that contain helpful use cases, comments, and related demonstrations of Redis features to help you level up your Redis game.
4
+
You can use RedisInsight's built-in tutorials to explore powerful Redis capabilities or create custom tutorials to present your experience using RedisInsight and share them with others.
6
5
7
-
If you want to share your own tutorials - add the `redis-tutorials` label to your GitHub repository and other GitHub users will be able to see and share your experience!
6
+
This page provides an overview of the Tutorials structure and its elements. It also contains instructions, recommendations, and best practices for creating, updating and sharing Tutorials.
7
+
8
+
If you want to share your custom tutorials with others, add the `redis-tutorials` label to your GitHub repository so other GitHub users can find them and learn your experience.
8
9
9
10
## Navigation
10
11
@@ -15,6 +16,7 @@ If you want to share your own tutorials - add the `redis-tutorials` label to you
15
16
5.[Manifest](#Manifest)
16
17
6.[Bulk Upload From Tutorials](#bulk-upload-from-tutorials)
17
18
7.[Advanced button parameters](#Advanced)
19
+
8.[Links configuration](#links-configuration)
18
20
19
21
## Structure
20
22
@@ -23,14 +25,21 @@ Tutorials should be combined into a .zip archive that contains the following:
23
25
2.[manifest.json](#Manifest) that describes the structure and behavior of Tutorials
24
26
25
27
## Examples
26
-
If you would like to start with Tutorials, download this example with Redis Stack Tutorials and upload the archive using the "Upload Tutorial" feature in RedisInsight Workbench so you can view and understand the overall logic.
28
+
If you are interested in creating your own tutorials and would like to understand how they work, you can start with the following steps:
29
+
- Download this example.
30
+
- Open RedisInsight.
31
+
- Navigate to the Insights panel (top right corner).
32
+
- Find the "My Tutorials" section on the "Explore" tab.
33
+
- Click the "Upload Tutorial" button and select the example.
34
+
35
+
Your first custom Tutorials are uploaded, and you can open and explore them.
In short, Tutorials support the basic [Markdown syntax](https://www.markdownguide.org/basic-syntax/) that you can use to specify your information.
33
-
If you would like to add a button that will insert Redis commands to the Workbench Editor, use Redis Code block that is almost the same as for the [Fenced Code Block](https://www.markdownguide.org/extended-syntax/#fenced-code-blocks), but you need to specify `redis` as language and the label next to it (see the `Create` button example below).
42
+
If you would like to add a button to run commands, use a Redis Code block that is almost the same as a [Fenced Code Block](https://www.markdownguide.org/extended-syntax/#fenced-code-blocks), but you need to specify `redis` as the language and write a label next to it (see the `Create` button example below).
34
43
35
44
````
36
45
```redis Create
@@ -50,7 +59,7 @@ If you would like to add a button that will insert Redis commands to the Workben
50
59
Basic [markdown syntax](https://www.markdownguide.org/basic-syntax/#images-1) provides the ability to render images.
51
60
52
61
To render images, you need to provide either an external URL to these images or a relative path to a folder inside of your tutorials.
53
-
The folder with images can have any name, but it is recommended to start it with an underscore (_) or a dot (.) to avoid displaying it in Workbench when the [manifest](#Manifest) is automatically generated.
62
+
The folder with images can have any name, but it is recommended to start it with an underscore (_) or a dot (.) to avoid displaying it in RedisInsight in cases when the [manifest](#Manifest) is automatically generated.
54
63
55
64
Use the following logic to specify a relative path:
56
65
@@ -66,34 +75,37 @@ For example:
66
75
67
76
## Manifest
68
77
69
-
Manifest.json is not required and can be skipped, in the case of missing manifest.json, RedisInsight will:
70
-
1. Take the Tutorial name from the .zip archive
71
-
2. All the pages will have names the same as file names in the .zip archive
72
-
3. The order of pages will be the same as in the .zip archive
78
+
`manifest.json` is an optional file that describes the structure and behavior of Tutorials.
79
+
If not specified, then RedisInsight will use the following logic:
80
+
81
+
1. the tutorial name is defined based on the name of the `.zip` archive
82
+
2. Page names are defined based on the file names in the `.zip` archive
83
+
3. The order of pages is defined based on the order in the `.zip` archive
73
84
74
-
If you would like to customize or prettify the archive name, page names, or the order, you can use the manifest.json. This JSON file is described as simple [Objects](https://javascript.info/object) which represents tree node and might have children nodes inside.
85
+
If you would like to customize or prettify the archive name, page names, or the order, you can use the `manifest.json`. This JSON file is described as simple [Objects](https://javascript.info/object) which represents tree node and might have children nodes inside.
75
86
76
-
Manifest file should start with single Node and should have properties described
87
+
The `manifest.json` file should start with single Node and should have properties described
| type (**required**) | "group", "internal-link" ||
95
106
| label (**required**) | string | Label that will be displayed on UI for Node |
96
-
| children | Node[]| Use only for the "group" type |
107
+
| summary | string | Short summary for the document (applied only for "internal-link" type) |
108
+
| children | Node[]| Use only for the "group" type |
97
109
| args | Record<string, any> | A special set of parameters required by a certain type of node (each type has its own) |
98
110
99
111
A Node can be represented by various UI components and is specified by `type` prop. Supported types are listed below.
@@ -127,7 +139,7 @@ The following syntax describes the `redis-upload` button:
127
139
**Notes:**
128
140
129
141
* use only a relative path to the text file inside the tutorial folder
130
-
* it is recommended to start the folder name with the text file from a dot (*.*) or underscore (*_*), so in the cases when the manifest file is automatically generated, RedisInsight will ignore this folder and not display it in your custom tutorial
142
+
* it is recommended to start the folder name with the text file from a dot (*.*) or underscore (*_*), so in the cases when the `manifest,json` file is automatically generated, RedisInsight will ignore this folder and not display it in your custom tutorial
131
143
* all the files included in your custom tutorials will be stored inside the RedisInsight folder as long as the tutorials exist in RedisInsight, so instead of including large text files in your custom tutorials, consider using Bulk Upload in Browser
132
144
133
145
**Example:**
@@ -165,7 +177,7 @@ as an absolute path from the tutorial folder.
165
177
166
178
You can customize the run parameters to configure the raw mode, pipeline parameter and group mode. If specified, they will override
167
179
the configuration set in RedisInsight. If not specified - the behaviour will be defined by parameters set in RedisInsight.
168
-
To specify the parameters, insert them after the `redis-auto:` and add the parameters in square brackets separated with a semicolon (`;`) in
180
+
To specify the parameters, insert them after the `redis:` and add the parameters in square brackets separated with a semicolon (`;`) in
169
181
the following way:
170
182
171
183
```
@@ -176,12 +188,12 @@ Ensure that all the parameters are listed **without spaces**, ordering does not
| results | * _single_<br/>*_group_<br/>*_silent_| If enabled, then pipeline mode is ignored | * _single_ - Disable the group mode to display the command results in a batch or as separate ones.<br/>*_group_ - Enable the group mode <br/>*_silent_: <br/>  1. Enable the group mode <br/>  2. Auto collapse the result <br/>  3. Show only error commands in the results|
182
-
| mode | * _ascii_<br/>*_raw_|| Enable/disable the raw mode to display command results. |
183
-
| pipeline | any integer number || Configure the number of commands in the pipeline. 0 or 1 pipelines every command. |
184
-
|auto| * _true_<br/>*_false_|| Configure the auto execute commands after click on the button|
| results | * _single_<br/>*_group_<br/>*_silent_| If enabled, then pipeline mode is ignored | * _single_ - Disable the group mode to display the command results in a batch or as separate ones.<br/>*_group_ - Enable the group mode <br/>*_silent_: <br/>  1. Enable the group mode <br/>  2. Auto collapse the result <br/>  3. Show only error commands in the results|
194
+
| mode | * _ascii_<br/>*_raw_|| Enable/disable the raw mode to display command results.|
195
+
| pipeline | any integer number || Configure the number of commands in the pipeline. 0 or 1 pipelines every command.|
196
+
|run_confirmation| * _true_| If _true_ RedisInsight will display confirmation dialog to run the commands | Enabling this parameter shows for particular query confirmation dialog|
A free Redis Stack instance on [Redis Cloud](https://redis.com/try-free/?utm_source=redis\&utm_medium=app\&utm_campaign=redisinsight_vecsim_guide"Redis Cloud").
0 commit comments