[skywalking-java] branch doc-polish updated: Set up compiling document.

[wu...@apache.org]

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

wusheng pushed a commit to branch doc-polish
in repository https://gitbox.apache.org/repos/asf/skywalking-java.git


The following commit(s) were added to refs/heads/doc-polish by this push:
     new f5c4d9e  Set up compiling document.
f5c4d9e is described below

commit f5c4d9ec74b9a87a0d797ea485d9b58d22a4c1fc
Author: Wu Sheng <wu...@foxmail.com>
AuthorDate: Mon Sep 13 17:46:02 2021 +0800

    Set up compiling document.
---
 README.md                         | 10 ----------
 docs/en/contribution/compiling.md | 18 ++++++++++++++++++
 docs/menu.yml                     |  2 ++
 3 files changed, 20 insertions(+), 10 deletions(-)

diff --git a/README.md b/README.md
index be54127..017bafc 100644
--- a/README.md
+++ b/README.md
@@ -20,16 +20,6 @@ SkyWalking: an APM(application performance monitor) system, especially designed
 # Downloads
 Please head to the [releases page](https://skywalking.apache.org/downloads/) to download a release of Apache SkyWalking.
 
-# Compiling project
-> git clone https://github.com/apache/skywalking-java.git
-> ./mvnw clean package -Pall
-
-The agent binary package is generated in `skywalking-agent` folder.
-
-Set **Generated Source Codes**(`grpc-java` and `java` folders in **apm-protocol/apm-network/target/generated-sources/protobuf**) 
-folders if you are using IntelliJ IDE.
-
-
 # Code of conduct
 This project adheres to the Contributor Covenant [code of conduct](https://www.apache.org/foundation/policies/conduct). By participating, you are expected to uphold this code.
 Please follow the [REPORTING GUIDELINES](https://www.apache.org/foundation/policies/conduct#reporting-guidelines) to report unacceptable behavior.
diff --git a/docs/en/contribution/compiling.md b/docs/en/contribution/compiling.md
new file mode 100644
index 0000000..48771ec
--- /dev/null
+++ b/docs/en/contribution/compiling.md
@@ -0,0 +1,18 @@
+# Compiling project
+This document will help you compile and build a project in your maven and set your IDE.
+
+Prepare JDK 8+.
+
+* If you clone codes from https://github.com/apache/skywalking-java
+> git clone https://github.com/apache/skywalking-java.git
+> cd skywalking-java
+> ./mvnw clean package -Pall
+
+* If you download source codes tar from https://skywalking.apache.org/downloads/
+
+> ./mvnw clean package
+
+The agent binary package is generated in `skywalking-agent` folder.
+
+Set **Generated Source Codes**(`grpc-java` and `java` folders in **apm-protocol/apm-network/target/generated-sources/protobuf**)
+folders if you are using IntelliJ IDE.
\ No newline at end of file
diff --git a/docs/menu.yml b/docs/menu.yml
index fc32588..8cbeb69 100644
--- a/docs/menu.yml
+++ b/docs/menu.yml
@@ -80,6 +80,8 @@ catalog:
         path: "https://skyapmtest.github.io/Agent-Benchmarks/"
   - name: "Contribution"
     catalog:
+      - name: "Compiling Guidance"
+        path: "/en/contribution/compiling/"
       - name: "Java Agent Release Guidance"
         path: "/en/contribution/release-java-agent/"
   - name: "Changelog"