File tree Expand file tree Collapse file tree 1 file changed +28
-0
lines changed
Expand file tree Collapse file tree 1 file changed +28
-0
lines changed Original file line number Diff line number Diff line change 1+ # SingleStore Spaces Contributing Guide
2+
3+ ## File structure
4+
5+ To add a new space you should create a new folder inside ` /notebooks ` .
6+
7+ Here are some requirements for the file structure
8+
9+ 1 . Folder name must be ` kebab-case `
10+ 2 . Folder must contain a Jupyter Notebook called ` notebook.ipynb `
11+ 3 . Folder must contain a ` meta.toml ` file which holds information about your SingleStore Space. See below for the structure of this file.
12+
13+ ### ` meta.toml ` file
14+
15+ Your ` meta.toml ` file should have a ` [meta] ` section with the following keys:
16+
17+ - title: string
18+ - description: string (optional)
19+ - tags: string[ ] (optional)
20+
21+ Example:
22+
23+ ``` toml
24+ [meta ]
25+ title =" Atlas & Kai for Mongo Side-by-Side"
26+ description =" Compare performance on same code from simple to more complex queries"
27+ tags =[" mongodb" , " kai" ]
28+ ```
You can’t perform that action at this time.
0 commit comments