Skip to content

Commit aa102a0

Browse files
committed
#RI-5118 - pr comments
1 parent f8fbdbd commit aa102a0

File tree

1 file changed

+15
-8
lines changed

1 file changed

+15
-8
lines changed

README.md

Lines changed: 15 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,16 @@ Tutorials should be combined into a .zip archive that contains the following:
2424
2. [manifest.json](#Manifest) that describes the structure and behavior of Tutorials
2525

2626
## Examples
27-
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.
27+
If you are interested in creating your own tutorials and would like to understand how they work, you can start with the following steps:
28+
- download this example
29+
- open RedisInsight
30+
- navigate to the Insights panel (top right corner)
31+
- find the "My Tutorials" section on the "Explore" tab
32+
- click the "Upload Tutorial" button and select the example
2833

29-
[Redis-Tutorials.zip](https://github.com/RedisInsight/Tutorials/files/11092920/Redis-Tutorials.zip)
34+
Your first custom Tutorials are uploaded, and you can open and explore them.
35+
36+
[Tutorials Example](https://github.com/RedisInsight/Tutorials/releases/download/2.42/data.zip)
3037

3138
## Markdown
3239

@@ -82,10 +89,10 @@ below (it will be displayed as type "group"):
8289
| label (**required**) | string | Label that will be displayed on UI for Node |
8390
| children (**required**) | Node[] | List of Nodes (nested groups or markdown files) |
8491
| type | | Can be skipped - RedisInsight will always use the "group" parameter |
85-
| author | string | Not required, Author name |
86-
| URL | string | Not required, link to repository/web-site |
87-
| industry | string[] | Not required, tags to show relevant industry |
88-
| description | string | Not required, short description of tutorials |
92+
| author | string | _Not required, not displayed_<br/> Author name |
93+
| URL | string | _Not required, not displayed_<br/> link to repository/web-site |
94+
| industry | string[] | _Not required, not displayed_<br/> tags to show relevant industry |
95+
| description | string | _Not required, not displayed_<br/> short description of tutorials |
8996

9097
Each Node requires a `label`,`type` (all available properties are described in the table below).
9198

@@ -195,12 +202,12 @@ _Examples:_
195202

196203
```
197204
redis:[results=single]
198-
redis:[auto=true;mode=raw]
205+
redis:[mode=raw]
199206
redis:[pipeline=1]
200207
redis:[results=silent;mode=raw]
201208
redis:[results=single;pipeline=4]
202209
redis:[results=group;mode=ascii]
203-
redis:[auto=true;pipeline=8;mode=raw;results=single;]
210+
redis:[pipeline=8;mode=raw;results=single;]
204211
```
205212

206213
### Internal links

0 commit comments

Comments
 (0)