Official document #90

oscar60310 · 2022-09-25T15:09:23Z

Description

Use nx start doc to start document server.

Issue ticket number

closes #52

Additional Context

codecov-commenter · 2022-09-25T15:12:51Z

Codecov Report

Base: 92.60% // Head: 92.60% // No change to project coverage 👍

Coverage data is based on head (2010620) compared to base (4cbc840).
Patch has no changes to coverable lines.

Additional details and impacted files

@@           Coverage Diff            @@
##           develop      #90   +/-   ##
========================================
  Coverage    92.60%   92.60%           
========================================
  Files          259      259           
  Lines         3798     3798           
  Branches       481      481           
========================================
  Hits          3517     3517           
  Misses         185      185           
  Partials        96       96

Flag	Coverage Δ
build	`94.90% <ø> (ø)`
cli	`89.38% <ø> (ø)`
core	`92.99% <ø> (ø)`
extension-dbt	`97.43% <ø> (ø)`
extension-debug-tools	`98.11% <ø> (ø)`
extension-driver-duckdb	`100.00% <ø> (ø)`
extension-driver-pg	`94.87% <ø> (ø)`
integration-testing	`96.15% <ø> (ø)`
serve	`90.38% <ø> (ø)`
test-utility	`∅ <ø> (∅)`

Flags with carried forward coverage won't be shown. Click here to find out more.

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

vercel · 2022-09-26T02:48:42Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Updated
vulcan-sql-document	✅ Ready (Inspect)	Visit Preview	Sep 29, 2022 at 2:49AM (UTC)

the first version of our official document Co-authored-by: JSYOU <Star2ver.Dev@gmail.com> Co-authored-by: Yi-Cheng Kuo <v6610688@gmail.com>

kokokuo

Only a little typo and suggestions, others LGTM 👍
Thanks so much for building the doc server and uploading documents to here.

kokokuo · 2022-09-27T13:11:24Z

packages/doc/docs/quickstart.mdx

+
+    ```sql
+    {% req user %}
+    SELECT COUNT(\*) AS count FROM customers


Is it should be COUNT(*)?

Yes, I'll fix it.

kokokuo · 2022-09-27T13:12:37Z

packages/doc/docs/quickstart.mdx

+    LIMIT 1
+    ```
+
+    We used the if expression to throw an error when the result equals `0`, VulcanSQL server will stop executing and respond immediately when meeting a {% error %} tag, `"CUSTOMER_NOT_FOUND"` is the error code we want to throw.


Can we add the quote to be {% error %} ?

kokokuo · 2022-09-27T13:13:46Z

packages/doc/docs/quickstart.mdx

+
+    ```sql
+    {% req user %}
+    SELECT COUNT(\*) AS count FROM customers


Is it should be COUNT(*)?

Yes, I'll fix it.

kokokuo · 2022-09-27T13:14:06Z

packages/doc/docs/quickstart.mdx

+    LIMIT 1
+    ```
+
+    {% set %} tag saved the result from the right side like most programming languages: `var someVar = someVal`, in this example, we saved the query result into `userCount` variable.


Can we add the quote to be {% set %} ?

kokokuo · 2022-09-27T13:19:06Z

packages/doc/docs/api-building/sql-template.mdx

+[{"arr":"1,2,3,4,4"}]%
+```
+
+Otherwise, you will see the above example always print the value to `$[number]` e.g: `$1` and then print the value in the terminal and display the `$1` as key and then shows the value.


Could you assist me to change the $[number] to $<number> ?

kokokuo · 2022-09-27T13:19:40Z

packages/doc/docs/api-building/sql-template.mdx

+
+### Raw Filter
+
+The `raw` filter is the VulcanSQL custom filer function, which could make your defined variable or dynamic parameter output value directly, it will transform `$[number]` to the value first and if you still have a pipe function after the `raw` , then it will use the output value to do the filter.


Same as here, could you assist me to change the $[number] to $<number>, thanks ?

kokokuo · 2022-09-27T13:22:23Z

packages/doc/docs/quickstart.mdx

+
+    We use `default` filter here to set the fallback value. When users don't send the parameter, we use a default value.
+
+    Unlike the last API, we use {% if %} expression the determine whether render the SQL or not, the queries in if blocks are only sent when the condition is satisfied.


Can we add the quote to be {% if %} ?

oscar60310 · 2022-09-27T09:16:03Z

packages/doc/docs/api-building/configuration.mdx

@@ -0,0 +1,323 @@
+# Configuration
+
+When using the VulcanSQL and creating the project through `vulcan init`, you will see a file named `vulcan.yaml` under the project root.


Suggested change

When using the VulcanSQL and creating the project through `vulcan init`, you will see a file named `vulcan.yaml` under the project root.

After creating a VulcanSQL project by `vulcan init`, you will see a file named `vulcan.yaml` under the project root.

oscar60310 · 2022-09-27T09:17:51Z

packages/doc/docs/api-building/configuration.mdx

+
+# Filename of Project Config
+
+Although the `vulcan.yaml` is the VulcanSQL project config name, but it is not mandatory actually. You could rename the project config file, but VulcanSQL will default use it when you play our command e.g: `vulcan build`, `vulcan serve`, or `vulcan start`.


Suggested change

Although the `vulcan.yaml` is the VulcanSQL project config name, but it is not mandatory actually. You could rename the project config file, but VulcanSQL will default use it when you play our command e.g: `vulcan build`, `vulcan serve`, or `vulcan start`.

Although we said that the `vulcan.yaml` is the VulcanSQL project config name, but it is not mandatory actually. You could rename the project config file, but VulcanSQL will default use it when you play our command e.g: `vulcan build`, `vulcan serve`, or `vulcan start`.

Thanks so much for modifying it!

oscar60310 · 2022-09-27T09:23:13Z

packages/doc/docs/api-building/configuration.mdx

+In the VulcanSQL project config, we will provide a section for you to define the project `name` and give the `description` for recording it so you or your partner could know the project's purpose. The `version` will record what VulcanSQL version you used, basically your installed version.
+
+```yaml
+name: my-first-vulcan-project
+description: A starter VulcanSQL project
+version: 0.2.0
+```


The version in config is the version of their project, which is controlled by uses. It has no relation with VulcanSQL~

Thanks so much for pointing it out.

oscar60310 · 2022-09-27T09:23:44Z

packages/doc/docs/api-building/configuration.mdx

+document-generator:
+  specs:
+    - oas3
+  folderPath: .


We've removed this.

Do you mean folderPath option only or all of document-generator ?

It is the folderPath, yes this is my misunderstanding, thanks so much.
If you mean all of document-generator, it still exists in the vulcan.yaml template of the cli package.

oscar60310 · 2022-09-27T13:47:07Z

packages/doc/docs/api-building/configuration.mdx

+Otherwise, VulcanSQL also has some external extensions which we have prepared, so if you would like to use external extensions, you could follow the below structure to define:
+


Suggested change

Otherwise, VulcanSQL also has some external extensions which we have prepared, so if you would like to use external extensions, you could follow the below structure to define:

VulcanSQL had created some external extensions, if you would like to use these extensions, you could follow the below structure to define them.

Thanks so much for modifying it!

oscar60310 · 2022-09-27T15:25:27Z

packages/doc/docs/api-building/access-log.mdx

+`enabled`
+
+- `default: true`
+- `typt: boolean`


Suggested change

- `typt: boolean`

- `type: boolean`

oscar60310 · 2022-09-27T15:26:31Z

packages/doc/docs/quickstart.mdx

+
+    ```sql
+    {% req user %}
+    SELECT COUNT(\*) AS count FROM customers


Yes, I'll fix it.

oscar60310 · 2022-09-27T15:27:00Z

packages/doc/docs/quickstart.mdx

+    LIMIT 1
+    ```
+
+    We used the if expression to throw an error when the result equals `0`, VulcanSQL server will stop executing and respond immediately when meeting a {% error %} tag, `"CUSTOMER_NOT_FOUND"` is the error code we want to throw.


oscar60310 · 2022-09-27T15:27:17Z

packages/doc/docs/quickstart.mdx

+
+    ```sql
+    {% req user %}
+    SELECT COUNT(\*) AS count FROM customers


Yes, I'll fix it.

oscar60310 · 2022-09-27T15:27:24Z

packages/doc/docs/quickstart.mdx

+    LIMIT 1
+    ```
+
+    {% set %} tag saved the result from the right side like most programming languages: `var someVar = someVal`, in this example, we saved the query result into `userCount` variable.


oscar60310 force-pushed the feature/init-document branch from cd16c3b to 5f981b9 Compare September 26, 2022 02:48

vercel bot deployed to Preview September 26, 2022 02:48 View deployment

vercel bot deployed to Preview September 26, 2022 04:15 View deployment

oscar60310 force-pushed the feature/init-document branch from 67bfc04 to 8eca4ea Compare September 26, 2022 06:08

vercel bot deployed to Preview September 26, 2022 06:08 View deployment

vercel bot deployed to Preview September 27, 2022 07:51 View deployment

vercel bot had a problem deploying to Preview September 27, 2022 08:11 Failure

docs(doc): init document

f8d8ef1

the first version of our official document Co-authored-by: JSYOU <Star2ver.Dev@gmail.com> Co-authored-by: Yi-Cheng Kuo <v6610688@gmail.com>

oscar60310 force-pushed the feature/init-document branch from 1181892 to f8d8ef1 Compare September 27, 2022 08:39

vercel bot deployed to Preview September 27, 2022 08:40 View deployment

fix(doc): rename vulcan to VulcanSQL

efcd449

vercel bot deployed to Preview September 27, 2022 08:55 View deployment

docs(doc): add access-og, cors, rate-limit and response-format document.

b32eeeb

vercel bot deployed to Preview September 27, 2022 11:57 View deployment

kokokuo approved these changes Sep 27, 2022

View reviewed changes

fix(doc): fix tag version and some typo of documents

1765dd5

oscar60310 commented Sep 27, 2022

View reviewed changes

vercel bot deployed to Preview September 27, 2022 15:31 View deployment

fix(doc): fix typos and align to latest changes

4572632

vercel bot deployed to Preview September 28, 2022 02:55 View deployment

docs(doc): update footer and project config

8f93e2c

vercel bot deployed to Preview September 28, 2022 03:09 View deployment

fix(doc): fix pr suggestions and typos

d25c4fd

vercel bot deployed to Preview September 28, 2022 03:10 View deployment

fix(doc): unite doc titles

cc5501d

vercel bot deployed to Preview September 28, 2022 06:01 View deployment

docs(doc): add part of landing page

f97c12e

vercel bot deployed to Preview September 28, 2022 10:53 View deployment

fix(doc): fix margins of features and actions

b1908da

vercel bot deployed to Preview September 28, 2022 11:26 View deployment

docs(doc): add features block in landing page

219d12c

vercel bot deployed to Preview September 28, 2022 18:25 View deployment

fix(fix): fix React keys, remove useless resources

f152e18

vercel bot deployed to Preview September 29, 2022 01:20 View deployment

fix(doc): fix some typos of feature list

903d0d5

vercel bot deployed to Preview September 29, 2022 01:42 View deployment

fix(doc): fix join Discord typos and fix the code block height

9519381

vercel bot deployed to Preview September 29, 2022 02:11 View deployment

fix(doc): change images of feature list

b94bbb2

vercel bot deployed to Preview September 29, 2022 02:49 View deployment

oscar60310 changed the title ~~[WIP] Official document~~ Official document Sep 29, 2022

oscar60310 marked this pull request as ready for review September 29, 2022 03:03

oscar60310 merged commit 65413b8 into develop Sep 29, 2022

oscar60310 deleted the feature/init-document branch September 29, 2022 03:04

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Official document #90

Official document #90

oscar60310 commented Sep 25, 2022 •

edited

Loading

codecov-commenter commented Sep 25, 2022

vercel bot commented Sep 26, 2022 •

edited

Loading

kokokuo left a comment

kokokuo Sep 27, 2022

oscar60310 Sep 27, 2022

kokokuo Sep 27, 2022

oscar60310 Sep 27, 2022

kokokuo Sep 27, 2022

oscar60310 Sep 27, 2022

kokokuo Sep 27, 2022

oscar60310 Sep 27, 2022

kokokuo Sep 27, 2022

kokokuo Sep 27, 2022

kokokuo Sep 27, 2022

oscar60310 Sep 27, 2022

oscar60310 Sep 27, 2022

kokokuo Sep 28, 2022

oscar60310 Sep 27, 2022

kokokuo Sep 28, 2022

oscar60310 Sep 27, 2022

kokokuo Sep 28, 2022

oscar60310 Sep 27, 2022

kokokuo Sep 28, 2022

oscar60310 Sep 27, 2022

oscar60310 Sep 27, 2022

oscar60310 Sep 27, 2022

oscar60310 Sep 27, 2022

oscar60310 Sep 27, 2022


		### Raw Filter

		The `raw` filter is the VulcanSQL custom filer function, which could make your defined variable or dynamic parameter output value directly, it will transform `$[number]` to the value first and if you still have a pipe function after the `raw` , then it will use the output value to do the filter.


		We use `default` filter here to set the fallback value. When users don't send the parameter, we use a default value.

		Unlike the last API, we use {% if %} expression the determine whether render the SQL or not, the queries in if blocks are only sent when the condition is satisfied.

		@@ -0,0 +1,323 @@
		# Configuration

		When using the VulcanSQL and creating the project through `vulcan init`, you will see a file named `vulcan.yaml` under the project root.

	When using the VulcanSQL and creating the project through `vulcan init`, you will see a file named `vulcan.yaml` under the project root.
	After creating a VulcanSQL project by `vulcan init`, you will see a file named `vulcan.yaml` under the project root.


		# Filename of Project Config

		Although the `vulcan.yaml` is the VulcanSQL project config name, but it is not mandatory actually. You could rename the project config file, but VulcanSQL will default use it when you play our command e.g: `vulcan build`, `vulcan serve`, or `vulcan start`.

	Although the `vulcan.yaml` is the VulcanSQL project config name, but it is not mandatory actually. You could rename the project config file, but VulcanSQL will default use it when you play our command e.g: `vulcan build`, `vulcan serve`, or `vulcan start`.
	Although we said that the `vulcan.yaml` is the VulcanSQL project config name, but it is not mandatory actually. You could rename the project config file, but VulcanSQL will default use it when you play our command e.g: `vulcan build`, `vulcan serve`, or `vulcan start`.

		Otherwise, VulcanSQL also has some external extensions which we have prepared, so if you would like to use external extensions, you could follow the below structure to define:

	Otherwise, VulcanSQL also has some external extensions which we have prepared, so if you would like to use external extensions, you could follow the below structure to define:
	VulcanSQL had created some external extensions, if you would like to use these extensions, you could follow the below structure to define them.

Official document #90

Official document #90

Conversation

oscar60310 commented Sep 25, 2022 • edited Loading

Description

Issue ticket number

Additional Context

codecov-commenter commented Sep 25, 2022

Codecov Report

vercel bot commented Sep 26, 2022 • edited Loading

kokokuo left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

oscar60310 commented Sep 25, 2022 •

edited

Loading

vercel bot commented Sep 26, 2022 •

edited

Loading