You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@shardingsphere.apache.org by pa...@apache.org on 2021/08/25 10:48:08 UTC

[shardingsphere] branch master updated: Add the build project document for the novice (#11997)

This is an automated email from the ASF dual-hosted git repository.

panjuan pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/shardingsphere.git


The following commit(s) were added to refs/heads/master by this push:
     new 66feea8  Add the build project document for the novice (#11997)
66feea8 is described below

commit 66feea80e036946c66343b2b3ecc9aced7f2466f
Author: wsm12138 <86...@users.noreply.github.com>
AuthorDate: Wed Aug 25 18:47:39 2021 +0800

    Add the build project document for the novice (#11997)
    
    * Add the build project document for the novice
    
    * delte Toc
    
    * Delete the maven
    
    * Delete the maven
---
 docs/community/content/contribute/2FA.cn.md        |   2 +-
 docs/community/content/contribute/2FA.en.md        |   2 +-
 .../content/contribute/code-conduct.cn.md          |   2 +-
 .../content/contribute/code-conduct.en.md          |   2 +-
 docs/community/content/contribute/committer.cn.md  |   2 +-
 docs/community/content/contribute/committer.en.md  |   2 +-
 .../community/content/contribute/contributor.cn.md |   2 +-
 .../community/content/contribute/contributor.en.md |   2 +-
 .../content/contribute/document-contributor.cn.md  |   2 +-
 .../content/contribute/document-contributor.en.md  |   2 +-
 .../content/contribute/establish-project.cn.md     | 104 ++++++++++++++++++
 .../content/contribute/establish-project.en.md     | 117 +++++++++++++++++++++
 docs/community/content/contribute/icla.cn.md       |   2 +-
 docs/community/content/contribute/icla.en.md       |   2 +-
 .../content/contribute/issue-conduct.cn.md         |   2 +-
 .../content/contribute/issue-conduct.en.md         |   2 +-
 .../content/contribute/release-elasticjob-ui.cn.md |   2 +-
 .../content/contribute/release-elasticjob-ui.en.md |   2 +-
 .../content/contribute/release-elasticjob.cn.md    |   2 +-
 .../content/contribute/release-elasticjob.en.md    |   2 +-
 docs/community/content/contribute/release.cn.md    |   2 +-
 docs/community/content/contribute/release.en.md    |   2 +-
 docs/community/content/contribute/release_ui.cn.md |   2 +-
 docs/community/content/contribute/release_ui.en.md |   2 +-
 docs/community/content/contribute/vote.cn.md       |   2 +-
 docs/community/content/contribute/vote.en.md       |   2 +-
 26 files changed, 245 insertions(+), 24 deletions(-)

diff --git a/docs/community/content/contribute/2FA.cn.md b/docs/community/content/contribute/2FA.cn.md
index 541dd87..6040ce0 100644
--- a/docs/community/content/contribute/2FA.cn.md
+++ b/docs/community/content/contribute/2FA.cn.md
@@ -1,6 +1,6 @@
 +++
 title = "2FA"
-weight = 11
+weight = 12
 chapter = true
 +++
 
diff --git a/docs/community/content/contribute/2FA.en.md b/docs/community/content/contribute/2FA.en.md
index 4355645..c950ee8 100644
--- a/docs/community/content/contribute/2FA.en.md
+++ b/docs/community/content/contribute/2FA.en.md
@@ -1,6 +1,6 @@
 +++
 title = "2FA"
-weight = 11
+weight = 12
 chapter = true
 +++
 
diff --git a/docs/community/content/contribute/code-conduct.cn.md b/docs/community/content/contribute/code-conduct.cn.md
index a26f0a4..651a93e 100644
--- a/docs/community/content/contribute/code-conduct.cn.md
+++ b/docs/community/content/contribute/code-conduct.cn.md
@@ -1,6 +1,6 @@
 +++
 title = "开发规范"
-weight = 4
+weight = 5
 chapter = true
 +++
 
diff --git a/docs/community/content/contribute/code-conduct.en.md b/docs/community/content/contribute/code-conduct.en.md
index 987b31a..65678ca 100644
--- a/docs/community/content/contribute/code-conduct.en.md
+++ b/docs/community/content/contribute/code-conduct.en.md
@@ -1,6 +1,6 @@
 +++
 title = "Code of Conduct" 
-weight = 4
+weight = 5
 chapter = true
 +++
 
diff --git a/docs/community/content/contribute/committer.cn.md b/docs/community/content/contribute/committer.cn.md
index f3c059c..8330767 100644
--- a/docs/community/content/contribute/committer.cn.md
+++ b/docs/community/content/contribute/committer.cn.md
@@ -1,6 +1,6 @@
 +++
 title = "提交者指南"
-weight = 3
+weight = 4
 chapter = true
 +++
 
diff --git a/docs/community/content/contribute/committer.en.md b/docs/community/content/contribute/committer.en.md
index a466184..257448c 100644
--- a/docs/community/content/contribute/committer.en.md
+++ b/docs/community/content/contribute/committer.en.md
@@ -1,6 +1,6 @@
 +++
 title = "Committer Guide"
-weight = 3
+weight = 4
 chapter = true
 +++
 
diff --git a/docs/community/content/contribute/contributor.cn.md b/docs/community/content/contribute/contributor.cn.md
index 685517f..702bac6 100644
--- a/docs/community/content/contribute/contributor.cn.md
+++ b/docs/community/content/contribute/contributor.cn.md
@@ -1,6 +1,6 @@
 +++
 title = "贡献者指南"
-weight = 2
+weight = 3
 chapter = true
 +++
 
diff --git a/docs/community/content/contribute/contributor.en.md b/docs/community/content/contribute/contributor.en.md
index fff9bab..d2db996 100644
--- a/docs/community/content/contribute/contributor.en.md
+++ b/docs/community/content/contribute/contributor.en.md
@@ -1,6 +1,6 @@
 +++
 title = "Contributor Guide"
-weight = 2
+weight = 3
 chapter = true
 +++
 
diff --git a/docs/community/content/contribute/document-contributor.cn.md b/docs/community/content/contribute/document-contributor.cn.md
index bdc96f8..59a7002 100644
--- a/docs/community/content/contribute/document-contributor.cn.md
+++ b/docs/community/content/contribute/document-contributor.cn.md
@@ -1,6 +1,6 @@
 +++
 title = "官方文档贡献指南"
-weight = 6
+weight = 7
 chapter = true
 +++
 
diff --git a/docs/community/content/contribute/document-contributor.en.md b/docs/community/content/contribute/document-contributor.en.md
index 57f8d45..4d2d35e 100644
--- a/docs/community/content/contribute/document-contributor.en.md
+++ b/docs/community/content/contribute/document-contributor.en.md
@@ -1,6 +1,6 @@
 +++
 title = "Documents Contributor Guide"
-weight = 6
+weight = 7
 chapter = true
 +++
 
diff --git a/docs/community/content/contribute/establish-project.cn.md b/docs/community/content/contribute/establish-project.cn.md
new file mode 100644
index 0000000..a057a0e
--- /dev/null
+++ b/docs/community/content/contribute/establish-project.cn.md
@@ -0,0 +1,104 @@
++++
+title = "搭建项目及环境指南"
+weight = 2
+chapter = true
++++
+
+
+# 本地构建 ShardingSphere 软件环境及获取最新安装包
+
+## 软件环境
+
+| **软件** | **JDK** |   **Idea**   |
+| :------: | :-----: | :----------: |
+| **版本** |  >=1.8  | 最新版本即可 |
+
+## 安装步骤（ Mac 为例）
+
+## 1.JDK 安装
+
+- 下方链接获取适合自己环境的安装包（ mac 选取 .dmg 格式）
+
+	https://www.oracle.com/java
+
+	![image-20210818115720737](https://note.youdao.com/yws/public/resource/ae044dae27b19d4d2f191c76e6df0a10/xmlnote/WEBRESOURCE98df8ecd49565fed4be4dfe594d04521/17060)
+
+- 下载完成后直接安装即可
+
+
+
+## 2.设置环境变量
+
+```shell
+vim ~/.zprofile
+```
+
+- 在下方添加环境变量：
+
+```shell
+#jdk环境通过 .dmg 方式安装后默认为下方路径
+JAVA_HOME=/Library/Java/JavaVirtualMachines/jdk1.8.0_301.jdk/Contents/Home
+PATH=$JAVA_HOME/bin:$PATH:.
+CLASSPATH=$JAVA_HOME/lib/tools.jar:$JAVA_HOME/lib/dt.jar:.
+
+export JAVA_HOME
+export PATH
+export CLASSPATH
+```
+
+```shell
+source ~/.zprofile
+```
+
+
+
+## 3.Idea 下载安装
+
+- 下方链接获取适合自己环境的安装包
+
+	https://www.jetbrains.com/idea/download/#section=mac
+- 下载后直接安装
+
+
+
+## 4.Idea clone 代码
+
+- 进入 Idea
+- 工具栏-->Git-->Clone-->Url(https://github.com/apache/shardingsphere.git)
+
+	![image-20210818110310185](https://note.youdao.com/yws/public/resource/d2c90a133be6216fadf355a5693af603/xmlnote/WEBRESOURCE714e7e0a63d84257f20230dbcc92fbbe/17045)
+- 等待结束就有刚刚克隆的最新的代码了
+
+
+
+## 5.项目编译
+
+```shell
+#假设项目路径为 /Users/hanmeimei/IdeaProjects/shardingsphere/
+
+cd /Users/hanmeimei/IdeaProjects/shardingsphere/
+```
+
+### 编译环境
+
+```shell
+./mvnw -Dmaven.javadoc.skip=true -Djacoco.skip=true -DskipITs -DskipTests clean install
+```
+
+### 获取最新的项目
+
+```shell
+./mvnw -Dmaven.javadoc.skip=true -Djacoco.skip=true -DskipITs -DskipTests clean install  -Prelease
+
+#进入下方目录位置
+cd /Users/hanmeimei/shardingsphere/shardingsphere/shardingsphere-distribution/shardingsphere-proxy-distribution/target
+
+#即可看到打包好最新的软件
+apache-shardingsphere-5.0.0-RC1-SNAPSHOT-shardingsphere-proxy-bin.tar.gz
+```
+
+
+
+## 结语
+
+完成以上操作后，您已经有了 ShardingSphere 的软件环境，可以根据[《贡献者指南》](https://shardingsphere.apache.org/community/cn/contribute/contributor/) 参与到 ShardingSphere 的社区建设
diff --git a/docs/community/content/contribute/establish-project.en.md b/docs/community/content/contribute/establish-project.en.md
new file mode 100644
index 0000000..1b1cdb4
--- /dev/null
+++ b/docs/community/content/contribute/establish-project.en.md
@@ -0,0 +1,117 @@
++++
+title = "Establish project and environmental guidelines"
+weight = 2
+chapter = true
++++
+
+
+# Establish the ShardingSphere software environment locally and obtain the latest installation package
+
+## Software environment
+
+
+
+| **Software** | **JDK** | **Idea** |
+|  :--:  | :--:  |:--:  |
+| **Version** |  >=1.8  |  The latest version  |
+
+## Installation Procedure (For example, Mac)
+
+
+
+## 1.The JDK installation
+
+
+- The following link is to obtain the installation package suitable for your environment (MAC select.dmg format).
+	https://www.oracle.com/java
+
+![image20210818115720737](https://note.youdao.com/yws/public/resource/ae044dae27b19d4d2f191c76e6df0a10/xmlnote/WEBRESOURCE98df8ecd49565fed4be4dfe594d04521/17060)
+
+- Install it directly after downloading
+
+
+
+## 2.Set the environment variable
+
+
+```shell
+vim ~/.zprofile
+```
+
+- Add the environment variable below:
+
+```shell
+#The following path is the default for the JDK environment installed in.dmg mode
+
+JAVA_HOME=/Library/Java/JavaVirtualMachines/jdk1.8.0_301.jdk/Contents/Home
+PATH=$JAVA_HOME/bin:$PATH:.
+CLASSPATH=$JAVA_HOME/lib/tools.jar:$JAVA_HOME/lib/dt.jar:.
+
+export JAVA_HOME
+export PATH
+export CLASSPATH
+```
+
+```shell
+source ~/.zprofile
+```
+
+
+
+## 3.Idea Download and install
+
+
+- The following link provides an installation package suitable for your environment
+
+	https://www.jetbrains.com/idea/download/#section=mac
+- Install it directly after downloading
+
+
+
+## 4.Idea clone code
+
+
+- Enter Idea
+- Toolbar-->Git-->Clone-->Url(https://github.com/apache/shardingsphere.git)
+
+	![image-20210818110310185](https://note.youdao.com/yws/public/resource/d2c90a133be6216fadf355a5693af603/xmlnote/WEBRESOURCE714e7e0a63d84257f20230dbcc92fbbe/17045)
+- At the end of the wait, there is the latest code that has just been cloned
+
+
+
+## 5.Compile the project
+
+
+```shell
+#Suppose the project path is /Users/hanmeimei/IdeaProjects/shardingsphere/
+
+cd /Users/hanmeimei/IdeaProjects/shardingsphere/
+```
+
+### Compile environment
+
+
+```shell
+./mvnw -Dmaven.javadoc.skip=true -Djacoco.skip=true -DskipITs -DskipTests clean install
+```
+
+### Get the latest projects
+
+
+```shell
+./mvnw -Dmaven.javadoc.skip=true -Djacoco.skip=true -DskipITs -DskipTests clean install  -Prelease
+
+#Go to the directory below
+cd /Users/hanmeimei/shardingsphere/shardingsphere/shardingsphere-distribution/shardingsphere-proxy-distribution/target
+
+#You can see the latest software packaged
+
+apache-shardingsphere-5.0.0-RC1-SNAPSHOT-shardingsphere-proxy-bin.tar.gz
+```
+
+
+
+## Conclusion:
+
+After completing the above operations, you have a ShardingSphere environment and can participate in the community building of ShardingSphere according to the [Contributors' Guide](https://shardingsphere.apache.org/community/en/contribute/contributor/)
+
diff --git a/docs/community/content/contribute/icla.cn.md b/docs/community/content/contribute/icla.cn.md
index 1edd0e1..21b6edb 100644
--- a/docs/community/content/contribute/icla.cn.md
+++ b/docs/community/content/contribute/icla.cn.md
@@ -1,6 +1,6 @@
 +++ 
 title = "签署iCLA指南" 
-weight = 12
+weight = 13
 chapter = true 
 +++
 
diff --git a/docs/community/content/contribute/icla.en.md b/docs/community/content/contribute/icla.en.md
index 2b84a67..38d7ba6 100644
--- a/docs/community/content/contribute/icla.en.md
+++ b/docs/community/content/contribute/icla.en.md
@@ -1,6 +1,6 @@
 +++ 
 title = "Sign ICLA Guide" 
-weight = 12
+weight = 13
 chapter = true 
 +++
 ### Sign Apache ICLA guide
diff --git a/docs/community/content/contribute/issue-conduct.cn.md b/docs/community/content/contribute/issue-conduct.cn.md
index f6605cc..7277d40 100644
--- a/docs/community/content/contribute/issue-conduct.cn.md
+++ b/docs/community/content/contribute/issue-conduct.cn.md
@@ -1,6 +1,6 @@
 +++
 title = "Issue 提交与处理规范"
-weight = 5
+weight = 6
 chapter = true
 +++
 
diff --git a/docs/community/content/contribute/issue-conduct.en.md b/docs/community/content/contribute/issue-conduct.en.md
index 82afee6..a40fb47 100644
--- a/docs/community/content/contribute/issue-conduct.en.md
+++ b/docs/community/content/contribute/issue-conduct.en.md
@@ -1,6 +1,6 @@
 +++
 title = "Issue Conduct"
-weight = 5
+weight = 6
 chapter = true
 +++
 
diff --git a/docs/community/content/contribute/release-elasticjob-ui.cn.md b/docs/community/content/contribute/release-elasticjob-ui.cn.md
index d97a9ac..595f6be 100644
--- a/docs/community/content/contribute/release-elasticjob-ui.cn.md
+++ b/docs/community/content/contribute/release-elasticjob-ui.cn.md
@@ -1,6 +1,6 @@
 +++
 title = "ElasticJob-UI发布指南"
-weight = 10
+weight = 11
 chapter = true
 +++
 
diff --git a/docs/community/content/contribute/release-elasticjob-ui.en.md b/docs/community/content/contribute/release-elasticjob-ui.en.md
index 8235681..21fd3ee 100644
--- a/docs/community/content/contribute/release-elasticjob-ui.en.md
+++ b/docs/community/content/contribute/release-elasticjob-ui.en.md
@@ -1,6 +1,6 @@
 +++
 title = "ElasticJob-UI Release Guide"
-weight = 10
+weight = 11
 chapter = true
 +++
 
diff --git a/docs/community/content/contribute/release-elasticjob.cn.md b/docs/community/content/contribute/release-elasticjob.cn.md
index 19b2fd0..21629a6 100644
--- a/docs/community/content/contribute/release-elasticjob.cn.md
+++ b/docs/community/content/contribute/release-elasticjob.cn.md
@@ -1,6 +1,6 @@
 +++
 title = "ElasticJob发布指南"
-weight = 9
+weight = 10
 chapter = true
 +++
 
diff --git a/docs/community/content/contribute/release-elasticjob.en.md b/docs/community/content/contribute/release-elasticjob.en.md
index 6c5ae68..0f9aa4e 100644
--- a/docs/community/content/contribute/release-elasticjob.en.md
+++ b/docs/community/content/contribute/release-elasticjob.en.md
@@ -1,6 +1,6 @@
 +++
 title = "ElasticJob Release Guide"
-weight = 9
+weight = 10
 chapter = true
 +++
 
diff --git a/docs/community/content/contribute/release.cn.md b/docs/community/content/contribute/release.cn.md
index a66bdad..d3db8f3 100644
--- a/docs/community/content/contribute/release.cn.md
+++ b/docs/community/content/contribute/release.cn.md
@@ -1,6 +1,6 @@
 +++
 title = "ShardingSphere发布指南"
-weight = 7
+weight = 8
 chapter = true
 +++
 
diff --git a/docs/community/content/contribute/release.en.md b/docs/community/content/contribute/release.en.md
index 9df2dbb..e4628fc 100644
--- a/docs/community/content/contribute/release.en.md
+++ b/docs/community/content/contribute/release.en.md
@@ -1,6 +1,6 @@
 +++
 title = "ShardingSphere Release Guide"
-weight = 7
+weight = 8
 chapter = true
 +++
 
diff --git a/docs/community/content/contribute/release_ui.cn.md b/docs/community/content/contribute/release_ui.cn.md
index 4232e44..006d95a 100644
--- a/docs/community/content/contribute/release_ui.cn.md
+++ b/docs/community/content/contribute/release_ui.cn.md
@@ -1,6 +1,6 @@
 +++
 title = "ShardingSphere-UI发布指南"
-weight = 8
+weight = 9
 chapter = true
 +++
 
diff --git a/docs/community/content/contribute/release_ui.en.md b/docs/community/content/contribute/release_ui.en.md
index ef5f9e1..8e52cd4 100644
--- a/docs/community/content/contribute/release_ui.en.md
+++ b/docs/community/content/contribute/release_ui.en.md
@@ -1,6 +1,6 @@
 +++
 title = "ShardingSphere-UI Release Guide"
-weight = 8
+weight = 9
 chapter = true
 +++
 
diff --git a/docs/community/content/contribute/vote.cn.md b/docs/community/content/contribute/vote.cn.md
index 0d2f6a9..6c7ff3a 100644
--- a/docs/community/content/contribute/vote.cn.md
+++ b/docs/community/content/contribute/vote.cn.md
@@ -1,6 +1,6 @@
 +++ 
 title = "提交者选举流程指南" 
-weight = 13
+weight = 14
 chapter = true 
 +++
 
diff --git a/docs/community/content/contribute/vote.en.md b/docs/community/content/contribute/vote.en.md
index c8e28bf..ecf2175 100644
--- a/docs/community/content/contribute/vote.en.md
+++ b/docs/community/content/contribute/vote.en.md
@@ -1,6 +1,6 @@
 +++ 
 title = "New committer voting process" 
-weight = 13
+weight = 14
 chapter = true 
 +++