You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@skywalking.apache.org by wu...@apache.org on 2018/09/13 12:16:54 UTC
[incubator-skywalking] branch docs updated: Adjust contribution
guides.
This is an automated email from the ASF dual-hosted git repository.
wusheng pushed a commit to branch docs
in repository https://gitbox.apache.org/repos/asf/incubator-skywalking.git
The following commit(s) were added to refs/heads/docs by this push:
new e1e4ad2 Adjust contribution guides.
e1e4ad2 is described below
commit e1e4ad2b231d90bf840c2def8ee2f3949924361d
Author: Wu Sheng <wu...@foxmail.com>
AuthorDate: Thu Sep 13 20:16:45 2018 +0800
Adjust contribution guides.
---
README.md | 2 +-
docs/README.md | 3 +--
docs/ROADMAP.md | 54 ------------------------------------------------
docs/en/guides/README.md | 34 ++++++++++++++++++++++--------
4 files changed, 27 insertions(+), 66 deletions(-)
diff --git a/README.md b/README.md
index 341d7d5..15cbd1b 100644
--- a/README.md
+++ b/README.md
@@ -71,7 +71,7 @@ Please report unacceptable behavior to dev@skywalking.apache.org .
Follow this [document](docs/en/guides/How-to-build.md).
# Contact Us
-* Submit an issue
+* Submit an [issue](https://github.com/apache/incubator-skywalking/issues)
* Mail list: dev@skywalking.apache.org
* [Gitter](https://gitter.im/openskywalking/Lobby)
* QQ Group: 392443393
diff --git a/docs/README.md b/docs/README.md
index a78822a..4c26627 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -7,8 +7,7 @@ From here you can learn all about **SkyWalking**’s architecture, how to deploy
SkyWalking. You can learn from here if you want to understand what is going on under our cool features and visualization.
- [Setup](en/setup/README.md). Setup contains guides for installing SkyWalking in different scenarios. As a platform, it provides
several ways to provide observability, including monitoring and alarm of course.
-- [Guides](en/guides/README.md). Guides are for PPMC, committer or new contributor. At here, you can know how to develop, release
-and what is ongoing of the community.
+- [Contribution Guides](en/guides/README.md). Guides are for PPMC, committer or new contributor. At here, you can know how to contribute from beginning.
- [Protocols](en/protocols/README.md). Protocols show the communication ways between agents/probes and backend. Anyone, interested
in uplink telemetry data, definitely should read this.
- [FAQs](en/FAQ/README.md). Include a manifest, including already known setup problems, secondary developments experiments. When
diff --git a/docs/ROADMAP.md b/docs/ROADMAP.md
deleted file mode 100644
index 1e9e480..0000000
--- a/docs/ROADMAP.md
+++ /dev/null
@@ -1,54 +0,0 @@
-# Roadmap
-The SkyWalking Roadmap includes three lists of features.
-1. The core features, means the SkyWalking PPMC and Committer team plan to implement in the near future.(6 months max)
-1. The community features, means the SkyWalking Team agrees the features are required, and welcome to accept the contributions.
-1. Long term features, means high value features, but can't be implemented recently.
-
-All the features of three lists are open for discussion.
-
-## Core features
-Core features are separated into 3 groups: agent, collector and UI.
-
-### Agent
-- Support OpenTracing-Java 0.31.0 or 1.0
-- Apache HttpClientComponent 3.x plugin.
-- Apache Tomcat6 plugin.
-- RabbitMQ plugin. All released version in the near 2 years should be supported at least.
-- MongoDB Java Driver 3.0 -> 3.2.x plugin.
-- Continue DB/Cache access span merged automatically.
-
-### Collector
-- Support config data downstream to agent. Need adjust TDP(Trace Data Protocol)
-- Support server metrics of other languages, such as C#. Need adjust TDP(Trace Data Protocol)
-- Alarm notification.
-- Baseline calculation, to make the alarm more accuracy.
-- Performance optimization (Stream metric aggregate and query for UI)
-- Automated testing (Stream metric aggregate and query for UI)
-- Remote module add kafka provider
-- Cluster module add redis provider
-
-### UI
-- Merged into Collector as a module.
-- Support i18n.
-- More interactive UI for the DIG data from any domain.
-- Plugin system for the 3rd extention of the UI.
-- Support dashboard on large screen.
-
-## Community features
-Community features are reported from SkyWalking community or the core team hopes community contributors provide the implementations.
-
-- Golang SDK as OpenCensus Reporter.
-- Support Sharding-JDBC as Collector storage implementor.
-- Support connect ES under auth, in Collector.
-
-## Long term features
-- More language supported: PHP, Nodejs Server, Python. OpenCensus reporter implementor or Auto-instrument agent.
-- Configure delivery/downstream from collector to agent.
-- [Java]Server profile
-- [Java]Specific service profile
-
-## Project release plan
-1. May. 2018, 5.0.0-beta
-1. Jun. 2018, 5.0.0-beta2
-1. Jul. 2018, 5.0.0-RC
-1. Jul. 2018, 5.0.0(GA)
diff --git a/docs/en/guides/README.md b/docs/en/guides/README.md
index 524d45d..d9557d1 100644
--- a/docs/en/guides/README.md
+++ b/docs/en/guides/README.md
@@ -1,13 +1,25 @@
# Guides
-Guides help everyone developer, including PPMC member, committer and contributor, to understand the project structure.
-Also learn to build the project, even to release the official Apache version(If you have been accepted as the formal committer).
+There are many ways that you can help the SkyWalking community.
-- [Compiling Guide](How-to-build.md). Teaches developer how to build the project in local.
-- [Apache Release Guide](How-to-release.md). Apache license allows everyone to redistribute if you keep our licenses and NOTICE
-in your redistribution. This document introduces to the committer team about doing official Apache version release, to avoid
-breaking any Apache rule.
+- Go through our documents, point out or fixed unclear things. Translate the documents to other languages.
+- Download our [releases](http://skywalking.apache.org/downloads/), try to monitor your applications, and feedback to us about
+what you think.
+- Read our source codes, Ask questions for details.
+- 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.
-## Project Extensions
+## 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: dev@skywalking.apache.org
+* [Gitter](https://gitter.im/openskywalking/Lobby)
+* QQ Group: 392443393
+
+## For code developer
+As a develop, first step, read [Compiling Guide](How-to-build.md). It teaches developer how to build the project in local.
+
+### Project Extensions
SkyWalking project supports many ways to extends existing features. If you are interesting in these ways,
read the following guides.
@@ -19,11 +31,15 @@ and private plugin developer should read this.
storage implementor besides the official.
-
-
-## UI developer
+### UI developer
Our UI is constituted by static pages and web container.
- **Static pages** is built based on [Ant Design Pro](https://pro.ant.design/), which source codes are
hosted in our [UI repository](https://github.com/apache/incubator-skywalking-ui).
- **Web container** source codes are in `apm-webapp` module. This is a just an easy zuul proxy to host
static resources and send GraphQL query requests to backend.
+
+## For release
+[Apache Release Guide](How-to-release.md) introduces to the committer team about doing official Apache version release, to avoid
+breaking any Apache rule. Apache license allows everyone to redistribute if you keep our licenses and NOTICE
+in your redistribution.
\ No newline at end of file