1
1
# QuestDB Documentation
2
2
3
- Uses [ Docusaurus] ( https://docusaurus.io/ ) .
3
+ Uses [ Docusaurus] ( https://docusaurus.io/ ) .
4
4
5
5
## Quick start
6
6
@@ -31,7 +31,7 @@ Most changes are reflected live without having to restart the server.
31
31
docker-compose up
32
32
```
33
33
34
- ## Contributing
34
+ ## Contributing
35
35
36
36
You'll need to sign a quick CLA.
37
37
@@ -49,23 +49,26 @@ Then push your branch to GitHub and create a PR.
49
49
50
50
We'll review the PR and generate a preview build.
51
51
52
- A QuestDB member must add the ` preview ` label to your PR to deploy a preview build.
52
+ A QuestDB member must add the ` preview ` label to your PR to deploy a preview
53
+ build.
53
54
54
55
Once it looks good, we'll merge!
55
56
56
- ### Enhancements, bugs, typos
57
+ ### Enhancements, bugs, typos
57
58
58
59
We'd love your help!
59
60
60
- Raise a [ GH issue] ( https://github.com/questdb/documentation/issues/new/choose ) or tackle a PR.
61
+ Raise a [ GH issue] ( https://github.com/questdb/documentation/issues/new/choose )
62
+ or tackle a PR.
61
63
62
64
## Syntax
63
65
64
66
### Railroad diagrams
65
67
66
68
Our SQL syntax diagrams are created using Railroad.
67
69
68
- To create a diagram, use the [ Railroad online editor] ( https://www.bottlecaps.de/rr/ui ) to see it rendered.
70
+ To create a diagram, use the
71
+ [ Railroad online editor] ( https://www.bottlecaps.de/rr/ui ) to see it rendered.
69
72
70
73
Once you're happy with it, copy the Railroad syntax and add it to:
71
74
@@ -90,19 +93,21 @@ For example:
90
93
python3 scripts/railroad.py renameTable
91
94
```
92
95
93
- During its final output, a markdown image with the appropriate syntax is printed:
96
+ During its final output, a markdown image with the appropriate syntax is
97
+ printed:
94
98
95
99
``` text
96
100
Copy the image syntax below and paste it into your markdown file:
97
101

98
102
```
99
103
100
- Copy this syntax and paste it into the markdown file where you want the diagram to appear.
104
+ Copy this syntax and paste it into the markdown file where you want the diagram
105
+ to appear.
101
106
102
107
The script requires:
103
108
104
- * Java (to run the ` rr.war ` file)
105
- * Python (to execute the ` railroad.py ` script)
109
+ - Java (to run the ` rr.war ` file)
110
+ - Python (to execute the ` railroad.py ` script)
106
111
107
112
### Math Expressions
108
113
@@ -189,3 +194,7 @@ On top of this, we follow the rules set by the
189
194
190
195
You do not need to run the linting task manually, Webpack will take care of that
191
196
for you.
197
+
198
+ In your editor, turn on "format on save".
199
+
200
+ It'll help!
0 commit comments