Skip to content

Commit 2323829

Browse files
authored
Merge pull request #134 from francis-du/master
[DOCS] Improved documentation and updated a blog
2 parents 61c7a55 + f1c0f5c commit 2323829

26 files changed

+166
-58
lines changed

docs/about/faq.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,3 @@
1-
[English](./faq.md)|[中文](../zh/about/faq.md)
1+
[English](./faq.md)|[中文](../zh/about/faq.md)
2+
3+
# FAQ

docs/about/license.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## **MIT License**
1+
# **MIT License**
22

33
**Copyright (c) 2018 <QSql Project>**
44

docs/about/release-notes.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[English](./release-notes.md)|[中文](../zh/about/release-notes.md)
22

3-
## **RELEASE-0.6**
3+
# **RELEASE-0.6**
44

55
**0.6版涉及的改动如下:**
66

@@ -24,5 +24,5 @@
2424

2525
- 支持混算模式下JDBC数据源的分布式查询。
2626

27-
## **RELEASE-0.5**
27+
# **RELEASE-0.5**
2828
-

docs/blog/2019.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
## 2019-08-27
1+
# 2019-08-27
22

33
[360多数据源混合查询引擎的前世今生 | 刘思源](https://mp.weixin.qq.com/s/ZdWi5CtBE_38t-brGkyB3g)
44

5-
## 2019-01-09
5+
# 2019-01-09
66

77
[Quicksql——更简单,更安全,更快速的跨数据源统一SQL查询引擎 | 360技术](https://mp.weixin.qq.com/s/XUFhq5iwK-Lfbf8vSXr7tA)

docs/blog/2020.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# 2020-01-03
2+
3+
[Quick SQL在线文档主题色投票结果 | Francis](articles/在线文档主题色投票结果.md)
Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# Quick SQL在线文档主题色投票结果出来啦
2+
3+
上周四,也就是2020年01月02日,我们发起了一个关于我们
4+
[在线文档的主题颜色投票](https://form.chinagdg.org/forms/d/e/1FAIpQLSc4CdXZsDZO3jat8rPgm9VEjXfrqlPQB5DCOva0OTcFemp16w/viewform)
5+
6+
首先呢,通过本次投票,极大的鼓舞了 Quick SQL 社区的小伙伴儿的积极性
7+
(虽然只有20个人参与),但是群里的小哥看到我们的新的文档
8+
表示一下充满了信心,要来贡献代码呢~-~
9+
10+
其次,我们正在逐渐的国际化,最近也开了Slack Channel,我们日常的一些
11+
开发和讨论都在[Slack](https://quicksql.readthedocs.io/en/latest/community/channel/)
12+
上,欢迎大家加入讨论和贡献[代码](https://quicksql.readthedocs.io/en/latest/community/contribution-code/)
13+
[文档](https://quicksql.readthedocs.io/en/latest/community/contribution-docs/)~
14+
另外我们的翻译平台也在逐步的建立。总之就是我们会越来越好哒^-^
15+
16+
拉好小板凳,现在让我来公布下投票结果~
17+
18+
获得我们`页面整体色调`人数最多奖的是... `Blue(15%)`
19+
20+
![primary](../../../images/primary-color-count.png)
21+
22+
获得我们`鼠标经过时色调`人数最多奖的是... `Red(20%)`
23+
24+
![accent](../../../images/accent-color-count.png)
25+
26+
我们接下来会将我们的主题颜色改成以上的两位获奖色
27+
感谢大家的投票,希望下次投票人能多点,`手动捂脸.jpg`
28+
29+
## 加入我们
30+
31+
[![Slack](../../../images/slack.png)](https://join.slack.com/t/quicksql/shared_invite/enQtODkwMzM0Njc3NTExLWQxNjRlY2M5YTlkMTk4OTM2YzhjMjUxYTUyN2VlNzJlNzQwM2E4YjkxNzA4MDllODg5NWUxNDY4MTMyMzczMWI)
32+
[![Github](../../../images/github.png)](https://github.com/qihoo360/Quicksql/issues)
33+
[![QQ](../../../images/qq.png)](https://jq.qq.com/?_wv=1027&k=5782R6F)
34+
35+
36+
37+

docs/community/channel.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## Join us
1+
# Join us
22

33
[![Slack](../images/slack.png)](https://join.slack.com/t/quicksql/shared_invite/enQtODkwMzM0Njc3NTExLWQxNjRlY2M5YTlkMTk4OTM2YzhjMjUxYTUyN2VlNzJlNzQwM2E4YjkxNzA4MDllODg5NWUxNDY4MTMyMzczMWI)
44
[![Github](../images/github.png)](https://github.com/qihoo360/Quicksql/issues)
Lines changed: 28 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,30 @@
11
[English](./contribution-code.md)|[中文](../zh/community/contribution-code.md)
22

3-
## Contributing code
3+
# Contributing Code
4+
5+
We welcome contributions.
6+
7+
If you are interested in Quicksql, you can download the source code from GitHub and execute the following maven command at the project root directory:
8+
9+
```shell
10+
mvn -DskipTests clean package
11+
```
12+
13+
If you are planning to make a large contribution, talk to us first! It helps to agree on the general approach. Log a Issures on GitHub for your proposed feature.
14+
15+
Fork the GitHub repository, and create a branch for your feature.
16+
17+
Develop your feature and test cases, and make sure that `mvn install` succeeds. (Run extra tests if your change warrants it.)
18+
19+
Commit your change to your branch.
20+
21+
If your change had multiple commits, use `git rebase -i master` to squash them into a single commit, and to bring your code up to date with the latest on the main line.
22+
23+
Then push your commit(s) to GitHub, and create a pull request from your branch to the QSQL master branch. Update the JIRA case to reference your pull request, and a committer will review your changes.
24+
25+
The pull request may need to be updated (after its submission) for two main reasons:
26+
27+
1. you identified a problem after the submission of the pull request;
28+
2. the reviewer requested further changes;
29+
30+
In order to update the pull request, you need to commit the changes in your branch and then push the commit(s) to GitHub. You are encouraged to use regular (non-rebased) commits on top of previously existing ones.

docs/community/contribution-docs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[English](./contribution-docs.md)|[中文](../zh/community/contribution-docs.md)
22

3-
## Contributing documents
3+
# Contributing documents
44

55
## Installing Python
66
Install [Python](https://www.python.org/) or [Anaconda](https://www.anaconda.com/).

docs/community/contributors.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
# Contributors
2+
13
Sort alphabetically,Show only GitHub ID without avatar.
24

35
### Without avatar

0 commit comments

Comments
 (0)