From 47140005638cfce03b0bc031af7eab091b1919f6 Mon Sep 17 00:00:00 2001 From: kezhenxu94 Date: Fri, 25 Dec 2020 11:54:06 +0800 Subject: [PATCH 1/3] Update doc "how to build from source" --- docs/FAQ.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/FAQ.md b/docs/FAQ.md index 719610b4..175d9896 100644 --- a/docs/FAQ.md +++ b/docs/FAQ.md @@ -23,4 +23,4 @@ git submodule update --init make install ``` -**NOTE** that because we use Git submodule, the aforementioned commands don't apply if you download the source codes (`.tgz`) from our official website. +**NOTE** that if you download the source codes (`.tgz`) from our official website, simply run `make install` without `git submodule update --init` because the submodules are packaged in the tar. From a1938f5490510054859dca5a451bb368622360c8 Mon Sep 17 00:00:00 2001 From: kezhenxu94 Date: Fri, 25 Dec 2020 11:59:58 +0800 Subject: [PATCH 2/3] Update doc "how to build from source" --- docs/FAQ.md | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/docs/FAQ.md b/docs/FAQ.md index 175d9896..57df2851 100644 --- a/docs/FAQ.md +++ b/docs/FAQ.md @@ -14,7 +14,15 @@ you can also disable the plugins via environment variables `SW_AGENT_DISABLE_PLU #### Q: How to build from sources? -#### A: If you want to build the SkyWalking Python Agent from source codes, for some reasons, for example, you want to try the latest features that're not released yet, please clone the source codes from GitHub and `make install` it: +#### A: Download the source tar from [the official website](http://skywalking.apache.org/downloads/), and run the following commands to build from source + +```shell +$ tar -zxf skywalking-python-src-.tgz +$ cd skywalking-python-src- +$ make install +``` + +If you want to build from the latest source codes from GitHub, for some reasons, for example, you want to try the latest features that are not released yet, please clone the source codes from GitHub and `make install` it: ```shell git clone https://github.com/apache/skywalking-python @@ -23,4 +31,4 @@ git submodule update --init make install ``` -**NOTE** that if you download the source codes (`.tgz`) from our official website, simply run `make install` without `git submodule update --init` because the submodules are packaged in the tar. +**NOTE** that only releases from [the website](http://skywalking.apache.org/downloads/) are official Apache releases. From fe8750021043fa1e53752e63af75817a04e92a5c Mon Sep 17 00:00:00 2001 From: kezhenxu94 Date: Fri, 25 Dec 2020 15:58:27 +0800 Subject: [PATCH 3/3] Add link to compiling and building --- CONTRIBUTING.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index afeea158..e4f3f237 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -20,6 +20,10 @@ Most of the contributions that we receive are code contributions, but you can al * If you're unable to find an issue addressing the problem, [open a new one](https://github.com/apache/skywalking/issues/new). Be sure to include a **title and clear description**, as much relevant information as possible, and a **code sample** or an **executable test case** demonstrating the expected behavior that is not happening. +## Compiling and building + +Check [here](docs/FAQ.md#q-how-to-build-from-sources). + ## Add a new feature or enhance an existing one _Before making any significant changes, please [open an issue](https://github.com/apache/skywalking/issues)._