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
+12-18
Original file line number
Diff line number
Diff line change
@@ -16,26 +16,20 @@ $ yarn start
16
16
17
17
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
18
18
19
-
### Build
19
+
### Build & Deployment
20
20
21
-
```
22
-
$ yarn build
23
-
```
24
-
25
-
This command generates static content into the `build` directory and can be served using any static contents hosting service.
21
+
- Pull-requests to `main` branch hook build (dry-run).
22
+
- Commits to `main` hook automatic deployment to `gh-pages` branch.
26
23
27
-
### Deployment
24
+
### Versioning
28
25
29
-
Using SSH:
26
+
- You should write docs for the next version in `docs/**`.
27
+
- URL: `/next/`
28
+
- After releasing the SpringQL `v0.15.0`, for example, run the following command and make a pull-request to `main` branch:
30
29
31
-
```
32
-
$ USE_SSH=true yarn deploy
33
-
```
34
-
35
-
Not using SSH:
36
-
37
-
```
38
-
$ GIT_USER=<Your GitHub username> yarn deploy
39
-
```
30
+
```console
31
+
yarn run docusaurus docs:version 0.15
32
+
```
40
33
41
-
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
34
+
- Note that you must not include the patch version because patch versions should not change the documents.
35
+
- If you find any document mistakes in older versions, you can directly edit the old version in `versioned_docs/version-*/**`. Then create a pull-request to `main` branch.
0 commit comments