Add compile and release docs. (#10)
diff --git a/docs/en/contribution/compiling.md b/docs/en/contribution/compiling.md
new file mode 100644
index 0000000..fe9b55e
--- /dev/null
+++ b/docs/en/contribution/compiling.md
@@ -0,0 +1,69 @@
+# Compiling project
+
+This document will help you compile and build the package file.
+
+Prepare PHP and Rust environments.
+
+## Install PHP Environment
+
+For Debian user:
+
+```shell
+sudo apt install php-cli php-dev
+```
+
+For MacOS user:
+
+```shell
+brew install php
+```
+
+## Install Rust Environment
+
+Install Rust globally.
+
+```shell
+export RUSTUP_HOME=/opt/rustup
+export CARGO_HOME=/opt/cargo
+
+curl https://sh.rustup.rs -sSf | sudo -E sh -s -- --no-modify-path
+sudo ln -s $CARGO_HOME/bin/rustup /usr/local/bin/rustup
+sudo ln -s $CARGO_HOME/bin/rustc /usr/local/bin/rustc
+sudo ln -s $CARGO_HOME/bin/cargo /usr/local/bin/cargo
+```
+
+## Install requirement
+
+For Debian user:
+
+```shell
+sudo apt install gcc make libclang protobuf-compiler
+```
+
+For MacOS user:
+
+```shell
+brew install protobuf
+```
+
+## Build and install Skywalking PHP Agent
+
+* If you clone codes from https://github.com/apache/skywalking-php
+
+ ```shell
+ git clone --recursive https://github.com/apache/skywalking-php.git
+ cd skywalking-php
+
+ phpize
+ ./configure
+ make
+ sudo make install
+ ```
+
+* If you download package tar from https://skywalking.apache.org/downloads/
+
+ ```shell
+ sudo pecl install skywalking_agent-x.y.z.tgz
+ ```
+
+The extension file `skywalking_agent.so` is generated in the php extension folder, get it by run `php-config --extension-dir`.
diff --git a/docs/en/contribution/release-agent.md b/docs/en/contribution/release-agent.md
new file mode 100644
index 0000000..9c75371
--- /dev/null
+++ b/docs/en/contribution/release-agent.md
@@ -0,0 +1,176 @@
+# Apache SkyWalking PHP Agent release guide
+
+If you're a committer, you can learn how to release SkyWalking SDK in The Apache Way and start the voting process by
+reading this document.
+
+## Requirements
+
+- Rust(rustc)
+- Cargo
+- PHP(php, php-config)
+- Pecl
+- GPG
+- shasum
+
+## Add your GPG public key
+
+1. Add your GPG public key into the [SkyWalking GPG KEYS](https://dist.apache.org/repos/dist/release/skywalking/KEYS)
+ file. If you are a committer, use your Apache ID and password to log in this svn, and update the file. **Don't
+ override the existing file.**(Notice, only PMC member could update this file)
+2. Upload your GPG public key to the public GPG site, such as [MIT's site](http://pgp.mit.edu:11371/). This site should
+ be in the Apache maven staging repository checklist.
+
+## Draft a new release
+
+Open [Create a new release](https://github.com/apache/skywalking-php/releases/new) page, choose the tag, and click the `Generate release notes` button, then copy the generated text to local `/tmp/notes.txt`.
+
+## Test your settings and package
+
+```shell
+## Make sure local compiling passed
+> cargo build
+
+## Create package.xml from package.xml.tpl
+> cargo run -p scripts --release -- create-package-xml --version x.y.z --notes "`cat /tmp/notes.txt`"
+
+## Create local package. The skywalking_agent-x.y.z.tgz should be found in project root
+> pecl package
+```
+
+## Sign the package
+
+Tag the commit ID of this release as v`x.y.z`.
+
+After set the version in `Cargo.toml` with the release number, package locally. Then run the following commands to sign
+your package.
+
+```shell
+> export RELEASE_VERSION=x.y.z
+
+## The package should be signed by your Apache committer mail.
+> gpg --armor --detach-sig skywalking_agent-{$RELEASE_VERSION}.tgz
+
+> shasum -a 512 skywalking_agent-{$RELEASE_VERSION}.tgz > skywalking_agent-{$RELEASE_VERSION}.tgz.sha512
+```
+
+After these, the source tar with its signed asc and sha512 are ready.
+
+## Upload to Apache SVN and tag a release
+
+1. Use your Apache ID to log in to `https://dist.apache.org/repos/dist/dev/skywalking/php`.
+2. Create a folder and name it by the release version and round, such as: `x.y.z`
+3. Upload tar ball, asc, sha512 files to the new folder.
+
+## Call a vote in dev
+
+Call a vote in `dev@skywalking.apache.org`
+
+```
+Mail title: [VOTE] Release Apache SkyWalking version PHP x.y.z
+
+Mail content:
+Hi All,
+This is a call for vote to release Apache SkyWalking PHP version x.y.z.
+
+Release Candidate:
+
+* https://dist.apache.org/repos/dist/dev/skywalking/php/x.y.z/
+* sha512 checksums
+- xxxxxxxx skywalking_agent-x.y.z.tgz
+
+Release Tag :
+
+* (Git Tag) vx.y.z
+
+Release CommitID :
+
+* https://github.com/apache/skywalking-php/tree/{commit-id}
+
+Keys to verify the Release Candidate :
+
+* https://dist.apache.org/repos/dist/release/skywalking/KEYS
+
+Guide to build the release from source :
+
+* https://github.com/apache/skywalking-php/blob/master/docs/en/contribution/compiling.md
+
+Voting will start now (Date) and will remain open for at least 72
+hours, Request all PMC members to give their vote.
+[ ] +1 Release this package.
+[ ] +0 No opinion.
+[ ] -1 Do not release this package because....
+```
+
+## Vote Check
+
+The voting process is as follows:
+
+1. All PMC member votes are +1 binding, and all other votes are +1 but non-binding.
+1. If you obtain at least 3 (+1 binding) votes with more +1 than -1 votes within 72 hours, the release will be approved.
+
+## Publish the release
+
+1. Move source codes tar and distribution packages to `https://dist.apache.org/repos/dist/release/skywalking/`.
+
+ ```shell
+ > export SVN_EDITOR=vim
+ > svn mv https://dist.apache.org/repos/dist/dev/skywalking/php/x.y.z https://dist.apache.org/repos/dist/release/skywalking/php
+ ....
+ enter your apache password
+ ....
+ ```
+
+2. Pecl publish package on [skywalking_agent](https://pecl.php.net/package/skywalking_agent).
+
+ Make sure you have a PECL account, and list in `package.tpl.xml` as `<developer>`,
+ or reach `private@skywalking.apache.org` if you are a committer/PMC but not listed.
+
+ You can request a PECL account via <https://pecl.php.net/account-request.php>.
+
+3. Add an release event, update download and doc releases on the SkyWalking website.
+
+4. Add the new release on [ASF addrelease site](https://reporter.apache.org/addrelease.html?skywalking).
+
+5. Remove the old releases on `https://dist.apache.org/repos/dist/release/skywalking/php/{previous-version}`.
+
+## Send a release announcement
+
+Send ANNOUNCE email to `dev@skywalking.apache.org`, `announce@apache.org`. The sender should use the Apache email
+account.
+
+```txt
+Mail title: [ANNOUNCE] Apache SkyWalking PHP x.y.z released
+
+Mail content:
+Hi all,
+
+SkyWalking PHP Agent provides the native tracing abilities for PHP project.
+
+SkyWalking: APM (application performance monitor) tool for distributed systems,
+especially designed for microservices, cloud native and container-based (Docker, Kubernetes, Mesos) architectures.
+
+This release contains a number of new features, bug fixes and improvements compared to
+version a.b.c(last release). The notable changes since x.y.z include:
+
+(Highlight key changes)
+1. ...
+2. ...
+3. ...
+
+Apache SkyWalking website:
+http://skywalking.apache.org/
+
+Downloads:
+http://skywalking.apache.org/downloads/
+
+Twitter:
+https://twitter.com/ASFSkyWalking
+
+SkyWalking Resources:
+- GitHub: https://github.com/apache/skywalking
+- Issue: https://github.com/apache/skywalking/issues
+- Mailing list: dev@skywalkiing.apache.org
+
+
+- Apache SkyWalking Team
+```
diff --git a/docs/en/setup/service-agent/php-agent/README.md b/docs/en/setup/service-agent/php-agent/README.md
index 1efc821..57e5ce9 100644
--- a/docs/en/setup/service-agent/php-agent/README.md
+++ b/docs/en/setup/service-agent/php-agent/README.md
@@ -4,28 +4,34 @@
2. Build from source
3. Configure php.ini
-## Build from source
+## Requirements
+
+For Debian-base OS:
```shell script
-sudo apt install gcc make rust libclang
+sudo apt install gcc make cargo libclang protobuf-compiler
```
+## Install from pecl.net
+
+```shell script
+sudo pecl install skywalking_agent
+```
+
+## Build & install from source
+
```shell script
git clone --recursive https://github.com/apache/skywalking-php.git
-
cd skywalking-php
-# Optional, specify if php isn't installed globally.
-# export PHP_CONFIG=<Your path of php-config>
-
-# Build libskywalking_agent.so.
-make build
-
-# Install to php extension dir.
-sudo make install
+phpize
+./configure
+make
+make install
```
## Configure php.ini
+
```ini
[skywalking]
extension=skywalking_agent.so
@@ -50,4 +56,4 @@
# Skywalking worker threads, 0 will auto set as the cpu core size.
# skywalking_agent.worker_threads = 3
-```
\ No newline at end of file
+```
diff --git a/docs/en/setup/service-agent/php-agent/Supported-list.md b/docs/en/setup/service-agent/php-agent/Supported-list.md
new file mode 100644
index 0000000..affedb6
--- /dev/null
+++ b/docs/en/setup/service-agent/php-agent/Supported-list.md
@@ -0,0 +1,13 @@
+# Supported SAPI, extension and library
+
+The following plugins provide the distributed tracing capability.
+
+## Supported SAPI
+
+* PHP-FPM
+
+## Support PHP extension
+
+* [cURL](https://www.php.net/manual/en/book.curl.php#book.curl)
+
+## Support PHP library
diff --git a/docs/menu.yml b/docs/menu.yml
index 3341024..94a5ba4 100644
--- a/docs/menu.yml
+++ b/docs/menu.yml
@@ -15,4 +15,14 @@
catalog:
- name: "PHP Agent Setup"
- path: "/en/setup/service-agent/php-agent/readme"
\ No newline at end of file
+ path: "/en/setup/service-agent/php-agent/readme"
+ - name: "Plugins"
+ catalog:
+ - name: "Supported SAPI, extension and library"
+ path: "/en/setup/service-agent/php-agent/Supported-list"
+ - name: "Contribution"
+ catalog:
+ - name: "Compiling Guidance"
+ path: "/en/contribution/compiling/"
+ - name: "PHP Agent Release Guidance"
+ path: "/en/contribution/release-agent/"
