Add compiling doc (#23)

.github/PULL_REQUEST_TEMPLATE

@@ -37,4 +37,4 @@
      ==== 🆕 Remove this line WHEN AND ONLY WHEN you're adding a new feature, follow the checklist 👆 ==== -->
 
 - [ ] If this pull request closes/resolves/fixes an existing issue, replace the issue number. Closes #<issue number>.
-- [ ] Update the [`CHANGES` log](https://github.com/apache/skywalking/blob/master/CHANGES.md).
+- [ ] Update the [`CHANGES` log](https://github.com/apache/skywalking-java/blob/main/CHANGES.md).

README.md

@@ -20,15 +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
-> ./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.
-
-
 # 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.

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.

docs/en/contribution/release-java-agent.md

@@ -45,7 +45,7 @@ This step is only for testing purpose. If your env is correctly set, you don't n
 ## Prepare for the release
 ```
 ./mvnw release:clean
-./mvnw release:prepare -DautoVersionSubmodules=true
+./mvnw release:prepare -DautoVersionSubmodules=true -Pall
 ```
 
 - Set version number as x.y.z, and tag as **v**x.y.z (The version tag must start with **v**. You will find out why this is necessary in the next step.)
@@ -54,7 +54,7 @@ _You could do a GPG signature before preparing for the release. If you need to i
 
 ## Stage the release 
 ```
-./mvnw release:perform -DskipTests
+./mvnw release:perform -DskipTests -Pall
 ```
 
 - The release will be automatically inserted into a temporary staging repository.

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"

pom.xml

@@ -125,6 +125,43 @@
 
     </properties>
 
+    <profiles>
+        <profile>
+            <id>all</id>
+            <activation>
+                <activeByDefault>false</activeByDefault>
+            </activation>
+            <build>
+                <plugins>
+                    <plugin>
+                        <groupId>org.codehaus.mojo</groupId>
+                        <artifactId>exec-maven-plugin</artifactId>
+                        <version>${exec-maven-plugin.version}</version>
+                        <executions>
+                            <execution>
+                                <id>git submodule update</id>
+                                <phase>initialize</phase>
+                                <inherited>false</inherited>
+                                <configuration>
+                                    <executable>git</executable>
+                                    <arguments>
+                                        <argument>submodule</argument>
+                                        <argument>update</argument>
+                                        <argument>--init</argument>
+                                        <argument>--recursive</argument>
+                                    </arguments>
+                                </configuration>
+                                <goals>
+                                    <goal>exec</goal>
+                                </goals>
+                            </execution>
+                        </executions>
+                    </plugin>
+                </plugins>
+            </build>
+        </profile>
+    </profiles>
+
     <dependencies>
         <dependency>
             <groupId>junit</groupId>