Skip to content

Commit 05839d1

Browse files
Update README.md
1 parent 9a879cd commit 05839d1

File tree

1 file changed

+56
-46
lines changed

1 file changed

+56
-46
lines changed

README.md

+56-46
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ If you want to share your own tutorials - add the `redis-tutorials` label to you
1010

1111
1. [Structure](#structure)
1212
2. [Examples](#examples)
13-
3. [Advanced button parameters](#advanced)
1413
3. [Bulk Upload From Tutorials](#bulk-upload-from-tutorials)
14+
4. [Advanced button parameters](#advanced)
1515

1616
## Structure
1717

@@ -85,6 +85,61 @@ A Node can be represented by various UI components and is specified by `type` pr
8585
> _**!Note.** All **"internal-link"** nodes located in the same **"group"** will be connected to each other. And using pagination (created dynamically) you can go directly from one page to another. Therefore, it is better to combine elements into groups related to the same topic._
8686
8787

88+
## Bulk Upload From Tutorials
89+
90+
You can upload sample data sets in bulk from your custom RedisInsight tutorials.
91+
To do so, you will need to:
92+
- create a text file with the list of Redis commands
93+
- add this file to the archive with your custom tutorials
94+
- create a special `redis-upload` button described in this section to execute all the Redis commands from custom tutorials
95+
96+
This button works similarly to the Bulk Upload in Browser, so all the Redis commands specified in the file will be executed.
97+
98+
The following syntax describes the `redis-upload` button:
99+
100+
````
101+
102+
```redis-upload:[{relative_path_to_the_text_file}] Upload data
103+
```
104+
105+
````
106+
**Notes:**
107+
108+
* use only a relative path to the text file inside the tutorial folder
109+
* 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
110+
* 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
111+
112+
**Example:**
113+
114+
For example, with the following structure of a custom tutorial:
115+
116+
```
117+
_data // a folder with the file to upload in bulk
118+
upload.txt
119+
folder_1 // a folder with custom tutorials
120+
my-tutorial.md
121+
manifest.json
122+
```
123+
124+
Use one of the following examples to specify the `redis-upload` button in `my-tutorial.md`:
125+
126+
````
127+
```redis-upload:[../_data/upload.txt] Upload data
128+
```
129+
````
130+
131+
as a relative path from `folder_1`
132+
133+
or
134+
135+
````
136+
```redis-upload:[./_data/upload.txt] Upload data
137+
```
138+
````
139+
140+
as an absolute path from the tutorial folder.
141+
142+
88143
## Advanced
89144

90145
You can customize the run parameters to configure the raw mode, pipeline parameter and group mode. If specified, they will override
@@ -125,48 +180,3 @@ redis:[results=group;mode=ascii]
125180
redis:[auto=true;pipeline=8;mode=raw;results=single;]
126181
```
127182

128-
## Bulk Upload From Tutorials
129-
130-
You can specify a special button for the Bulk Upload, upon clicking which,
131-
a text file with redis commands will be loaded and executed. It works the same as Bulk Upload in Browser.
132-
133-
To specify bulk upload button, you have to use the following syntax:
134-
135-
````
136-
137-
```redis-upload:[{path_to_file}] Upload data
138-
```
139-
140-
````
141-
_Notes:_
142-
143-
* You can use a relative path to text file inside the tutorial folder
144-
* If manifest is not specified, folder with bulk upload text files should start with *.* or *_*
145-
* Text files included into tutorial will be stored as long as tutorial
146-
147-
_Example_:
148-
For example, we have the following structure of tutorial:
149-
```
150-
_data // folder with bulk upload text file
151-
upload.txt
152-
folder_1 // folder with tutorial
153-
my-tutorial.md
154-
manifest.json
155-
```
156-
157-
In *my-tutorial.md* `redis-upload` button can be specified as:
158-
159-
````
160-
```redis-upload:[../_data/upload.txt] Upload data
161-
```
162-
````
163-
as relative path from current folder_1
164-
165-
or
166-
````
167-
```redis-upload:[./_data/upload.txt] Upload data
168-
```
169-
````
170-
as absolute path from tutorial folder
171-
172-

0 commit comments

Comments
 (0)