Skip to content

Commit 6261bb2

Browse files
rsergeenkorsergeenko
committed
#RI-5118 - update readme
1 parent 4d1cde0 commit 6261bb2

File tree

1 file changed

+68
-18
lines changed

1 file changed

+68
-18
lines changed

‎README.md

Lines changed: 68 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ If you want to share your own tutorials - add the `redis-tutorials` label to you
1515
5. [Manifest](#Manifest)
1616
6. [Bulk Upload From Tutorials](#bulk-upload-from-tutorials)
1717
7. [Advanced button parameters](#Advanced)
18+
7. [Links configuration](#links-configuration)
1819

1920
## Structure
2021

@@ -76,24 +77,25 @@ If you would like to customize or prettify the archive name, page names, or the
7677
Manifest file should start with single Node and should have properties described
7778
below (it will be displayed as type "group"):
7879

79-
| Prop | Type | Description |
80-
|-------------------------|--------------------------|-------------------------------------------------------------------------------------------------------------------------------|
81-
| label (**required**) | string | Label that will be displayed on UI for Node |
82-
| children (**required**) | Node[] | List of Nodes (nested groups or markdown files) |
83-
| type | | Can be skipped - RedisInsight will always use the "group" parameter |
84-
| author | string | Not required, Author name |
85-
| URL | string | Not required, link to repository/web-site |
86-
| industry | string[] | Not required, tags to show relevant industry |
87-
| description | string | Not required, short description of tutorials |
80+
| Prop | Type | Description |
81+
|-------------------------|----------|---------------------------------------------------------------------|
82+
| label (**required**) | string | Label that will be displayed on UI for Node |
83+
| children (**required**) | Node[] | List of Nodes (nested groups or markdown files) |
84+
| 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 |
8889

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

9192
| Prop | Type | Description |
9293
|----------------------|--------------------------|----------------------------------------------------------------------------------------|
93-
| id | string | |
94+
| id (**required**) | string | |
9495
| type (**required**) | "group", "internal-link" | |
9596
| label (**required**) | string | Label that will be displayed on UI for Node |
96-
| children | Node[] | Use only for the "group" type |
97+
| summary | string | Short summary for the document (applied only for "internal-link" type) |
98+
| children | Node[] | Use only for the "group" type |
9799
| args | Record<string, any> | A special set of parameters required by a certain type of node (each type has its own) |
98100

99101
A Node can be represented by various UI components and is specified by `type` prop. Supported types are listed below.
@@ -165,7 +167,7 @@ as an absolute path from the tutorial folder.
165167

166168
You can customize the run parameters to configure the raw mode, pipeline parameter and group mode. If specified, they will override
167169
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
170+
To specify the parameters, insert them after the `redis:` and add the parameters in square brackets separated with a semicolon (`;`) in
169171
the following way:
170172

171173
```
@@ -176,12 +178,12 @@ Ensure that all the parameters are listed **without spaces**, ordering does not
176178

177179
_Supported parameters:_
178180

179-
| Name | Values | Notes | Description |
180-
|----------|--------------------------|-------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------|
181-
| 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/>&emsp; 1. Enable the group mode <br/>&emsp; 2. Auto collapse the result <br/>&emsp; 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 |
181+
| Name | Values | Notes | Description |
182+
|------------------|-----------------------------------------|-----------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
183+
| 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/>&emsp; 1. Enable the group mode <br/>&emsp; 2. Auto collapse the result <br/>&emsp; 3. Show only error commands in the results |
184+
| mode | * _ascii_<br/>* _raw_ | | Enable/disable the raw mode to display command results. |
185+
| pipeline | any integer number | | Configure the number of commands in the pipeline. 0 or 1 pipelines every command. |
186+
| run_confirmation | * _true_ | If _true_ RedisInsight will display confirmation dialog to run the commands | Enabling this parameter shows for particular query confirmation dialog |
185187

186188

187189
_Notes:_
@@ -200,3 +202,51 @@ redis:[results=single;pipeline=4]
200202
redis:[results=group;mode=ascii]
201203
redis:[auto=true;pipeline=8;mode=raw;results=single;]
202204
```
205+
206+
### Links configuration
207+
208+
#### Internal links
209+
You can insert links that lead to a specific page. The syntax for these links is following:
210+
```
211+
[{text}](redisinsight:{path})
212+
```
213+
214+
For example:
215+
```
216+
[Browser](redisinsight:browser)
217+
```
218+
219+
The full list of pages:
220+
221+
| Page | path |
222+
|---------------------------------------------|-------------------------------|
223+
| Home Page (List of databases) | / |
224+
| Browser | browser |
225+
| Workbench | workbench |
226+
| Analytics (will be redirected to first tab) | analytics |
227+
| Cluster Details | analytics/cluster-details |
228+
| Database Analysis | analytics/database-analysis |
229+
| Slow Log | analytics/slowlog |
230+
| Pub Sub | pub-sub |
231+
| Triggers and Functions | triggered-functions |
232+
| Libraries | triggered-functions/libraries |
233+
| Functions | triggered-functions/functions |
234+
| Settings | settings |
235+
236+
#### Create a free Cloud database link
237+
238+
Also, there is a possibility to insert link which opens Create Free Database dialog inside RedisInsight
239+
240+
> *Note*: For Docker builds these links will work as pure external links
241+
242+
Syntax:
243+
```
244+
[{title}]({link} 'Redis Cloud')
245+
```
246+
247+
For example:
248+
```
249+
[Create a free database](https://redis.com/try-free 'Redis Cloud')
250+
```
251+
252+

0 commit comments

Comments
 (0)