This is an automated email from the ASF dual-hosted git repository.
wusheng pushed a commit to branch doc-improve
in repository https://gitbox.apache.org/repos/asf/incubator-skywalking.git
commit 229c689e744f4cd2e41e2003d0bee3975d6fddba
Author: Wu Sheng <wu.sh...@foxmail.com>
AuthorDate: Fri Dec 14 14:04:39 2018 -0800
Add documents for clear things.
---
README.md | 2 +-
docs/en/guides/How-to-release.md | 17 +++++++++++++----
docs/en/guides/README.md | 9 ++++++++-
3 files changed, 22 insertions(+), 6 deletions(-)
diff --git a/README.md b/README.md
index c24f908..f000ab5 100644
--- a/README.md
+++ b/README.md
@@ -86,7 +86,7 @@ Follow this [document](docs/en/guides/How-to-build.md).
# Contact Us
* Submit an [issue](https://github.com/apache/incubator-skywalking/issues)
-* Mail list: d...@skywalking.apache.org
+* Mail list: **d...@skywalking.apache.org**. Mail to
`dev-subscr...@skywalking.apache.org`, follow the reply to subscribe the mail
list.
* [Gitter](https://gitter.im/openskywalking/Lobby)
* QQ Group: 392443393
diff --git a/docs/en/guides/How-to-release.md b/docs/en/guides/How-to-release.md
index 60f8635..ff560ab 100644
--- a/docs/en/guides/How-to-release.md
+++ b/docs/en/guides/How-to-release.md
@@ -5,6 +5,9 @@ and also help committers to check the release for vote.
## Setup your development environment
+Follow [Apache maven deployment environment
document](http://www.apache.org/dev/publishing-maven-artifacts.html#dev-env)
+to set gpg tool and encrypt passwords
+
Use the following block as a template and place it in ~/.m2/settings.xml
```
@@ -43,21 +46,27 @@ Use the following block as a template and place it in
~/.m2/settings.xml
```
./mvnw release:perform -DskipTests -Pauto-submodule
```
-1. Set version number as x.y.z, and tag as vx.y.z
+1. Set version number as x.y.z, and tag as **v**x.y.z (version tag must start
with **v**, you will find the purpose in next step.)
1. The release will automatically be inserted into a temporary staging
repository for you.
## Build and sign the source code package
```shell
-switch to release version tag
export RELEASE_VERSION=x.y.z (example: RELEASE_VERSION=5.0.0-alpha)
cd tools/releasing
sh create_source_release.sh
```
-`RELEASE_ROUND` must be as same as your setting in `Stage the release` step.
+**NOTICE**, `create_source_release.sh` is just suitable for MacOS. Welcome
anyone to contribute Windows bat and Linux shell.
+
+This scripts should do following things
+1. Use `v` + `RELEASE_VERSION` as tag to clone the codes.
+1. Make `git submodule init/update` done.
+1. Exclude all unnecessary files in the target source tar, such as .git,
.github, .gitmodules. See the script for the details.
+1. Do `gpg` and `shasum 512`.
+
The `apache-skywalking-apm-incubating-x.y.z-src.tgz` should be found in
`tools/releasing` folder,
-with .asc, .sha512, .md5
+with .asc, .sha512.
## Find and download distribution in Apache Nexus Staging repositories
1. Use ApacheId to login `https://repository.apache.org/`
diff --git a/docs/en/guides/README.md b/docs/en/guides/README.md
index eaf8c1e..26f0033 100644
--- a/docs/en/guides/README.md
+++ b/docs/en/guides/README.md
@@ -8,11 +8,18 @@ what you think.
- Find some bugs, [submit
issue](https://github.com/apache/incubator-skywalking/issues), and try to fix
it.
- Find [help wanted
issues](https://github.com/apache/incubator-skywalking/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22),
which are good for you to start.
+- Submit issue or start discussion through [GitHub
issue](https://github.com/apache/incubator-skywalking/issues/new).
+- See all mail list discussion through [website list
review](https://lists.apache.org/list.html?d...@skywalking.apache.org).
+If you are a SkyWalking committer, could login and use the mail list in
browser mode. Otherwise,
+follow the next step to subscribe.
+- Issue report and discussion also could take place in
`d...@skywalking.apache.org`.
+Mail to `dev-subscr...@skywalking.apache.org`, follow the reply to subscribe
the mail list.
+
## Contact Us
All the following channels are open to the community, you could choose the way
you like.
* Submit an [issue](https://github.com/apache/incubator-skywalking/issues)
-* Mail list: d...@skywalking.apache.org
+* Mail list: **d...@skywalking.apache.org**. Mail to
`dev-subscr...@skywalking.apache.org`, follow the reply to subscribe the mail
list.
* [Gitter](https://gitter.im/openskywalking/Lobby)
* QQ Group: 392443393
