Skip to content

Commit 7efd33d

Browse files
committed
docs: write about versioning in README
1 parent 25f3b8a commit 7efd33d

File tree

1 file changed

+12
-18
lines changed

1 file changed

+12
-18
lines changed

README.md

+12-18
Original file line numberDiff line numberDiff line change
@@ -16,26 +16,20 @@ $ yarn start
1616

1717
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
1818

19-
### Build
19+
### Build & Deployment
2020

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.
2623

27-
### Deployment
24+
### Versioning
2825

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:
3029

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+
```
4033

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

Comments
 (0)