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
+9-7Lines changed: 9 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -75,14 +75,16 @@ For example:
75
75
76
76
## Manifest
77
77
78
-
Manifest.json is not required and can be skipped, in the case of missing manifest.json, RedisInsight will:
79
-
1. Take the Tutorial name from the .zip archive
80
-
2. All the pages will have names the same as file names in the .zip archive
81
-
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:
82
80
83
-
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.
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
84
84
85
-
Manifest file should start with single Node and should have properties described
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.
86
+
87
+
The `manifest.json` file should start with single Node and should have properties described
86
88
below (it will be displayed as type "group"):
87
89
88
90
| Prop | Type | Description |
@@ -137,7 +139,7 @@ The following syntax describes the `redis-upload` button:
137
139
**Notes:**
138
140
139
141
* use only a relative path to the text file inside the tutorial folder
140
-
* 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
141
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
0 commit comments