This is an automated email from the ASF dual-hosted git repository. wangxin pushed a commit to branch asf-site in repository https://gitbox.apache.org/repos/asf/incubator-dubbo-website.git
The following commit(s) were added to refs/heads/asf-site by this push: new 1afd81c translate the developer guide,issue #181 (#190) 1afd81c is described below commit 1afd81c37a7a91f51ae3e5a8724ca3c568fea276 Author: ateacer <lixiaojie_...@outlook.com> AuthorDate: Tue Nov 27 13:00:32 2018 +0800 translate the developer guide,issue #181 (#190) * translate the new contribute guide * translate the developer guide * translate the document label an issue guide --- .../committer-guide/label-an-issue-guide_dev.md | 25 +++++ .../committer-guide/website-guide_dev.md | 6 +- .../contributor-guide/cla-signing-guide_dev.md | 23 +++++ .../contributor-guide/dubbo-extension-guide_dev.md | 48 ++++++++- .../mailing-list-subscription-guide_dev.md | 79 +++++++++++++- .../software-donation-guide_dev.md | 113 ++++++++++++++++++++- docs/zh-cn/developers/user-guide/faq_dev.md | 26 ++++- 7 files changed, 315 insertions(+), 5 deletions(-) diff --git a/docs/zh-cn/developers/committer-guide/label-an-issue-guide_dev.md b/docs/zh-cn/developers/committer-guide/label-an-issue-guide_dev.md index 8f40cd8..55bee74 100644 --- a/docs/zh-cn/developers/committer-guide/label-an-issue-guide_dev.md +++ b/docs/zh-cn/developers/committer-guide/label-an-issue-guide_dev.md @@ -1,2 +1,27 @@ # 给问题打标签 +如果您正在处理一个问题,请记得**给这个问题标记一个或者多个您认为有意义的标签**。有了标签,其他开发人员就会很轻松地识别出问题,以便对其进行分类并跟踪进度。 + +对于需要编码和发版修复的issues和pull requests,需要您**将其标记为[milestone](https://github.com/apache/incubator*dubbo/milestones)**。 + +一些常用的标签: + +* 请求帮助 + * help wanted + * good first issue +* 优先级 + * priority/blocker + * priority/high + * priority/low + * priority/normal +* 状态 + * status/need-triage + * status/DO-NOT-MERGE + * status/READY-TO-MERGE + * status/invalid + * status/wontfix +* 类型 + * type/bug + * type/documentation + * type/enhancement + * type/feature diff --git a/docs/zh-cn/developers/committer-guide/website-guide_dev.md b/docs/zh-cn/developers/committer-guide/website-guide_dev.md index 77695ec..5741a2f 100644 --- a/docs/zh-cn/developers/committer-guide/website-guide_dev.md +++ b/docs/zh-cn/developers/committer-guide/website-guide_dev.md @@ -1 +1,5 @@ -# 网站向导 \ No newline at end of file +# 网站向导 + +1. Apache Dubbo(incubating) 的网站仓库是 https://github.com/apache/incubator-dubbo-website +2. 网站构建完毕后,它会被自动发布到 dubbo.apache.org,您也可以通过 https://selfserve.apache.org 手动触发(需要使用 Apache 账号登陆) + diff --git a/docs/zh-cn/developers/contributor-guide/cla-signing-guide_dev.md b/docs/zh-cn/developers/contributor-guide/cla-signing-guide_dev.md index e7d224b..6ae7a04 100644 --- a/docs/zh-cn/developers/contributor-guide/cla-signing-guide_dev.md +++ b/docs/zh-cn/developers/contributor-guide/cla-signing-guide_dev.md @@ -1 +1,24 @@ # CLA签署向导 + +以下情况,需要您签署Apache ICLA: + +* 在Dubbo被捐赠给Apache之前,您已经为Dubbo作出了很多贡献,并且您以前没有签署过Alibaba-CLA。 +* 您已经为Dubbo作出了很多贡献,并且您被邀请成为Dubbo提交者,且之前没有签署过Alibaba-CLA或者Apache ICLA。 + +### 步骤 + +* 下载这篇[pdf文档](https://www.apache.org/licenses/icla.pdf) +* 编辑该文档,在必要的空格处填上适当的内容 +* 打印 +* 在打印好的文件上签字 +* 扫描 +* 发送一封邮件到secret...@apache.org,并抄送给priv...@dubbo.apache.org: + * 邮件标题为“ICLA submission” + * 请在邮件正文附上您的github账号链接 + * 请记得将您的ICLA文档放入邮件的附件里 + +### 空格填写必要说明 + +* Mailing address:首选英文格式的公司地址 +* preferred apache id(s):如果您被邀请成为一名提交者,那么需要您填写一个apache账号,否则,可以不填 +* notify project:Dubbo(意思就是Dubbo就是通知您签署ICLA的项目) \ No newline at end of file diff --git a/docs/zh-cn/developers/contributor-guide/dubbo-extension-guide_dev.md b/docs/zh-cn/developers/contributor-guide/dubbo-extension-guide_dev.md index da06568..79c1ef2 100644 --- a/docs/zh-cn/developers/contributor-guide/dubbo-extension-guide_dev.md +++ b/docs/zh-cn/developers/contributor-guide/dubbo-extension-guide_dev.md @@ -1 +1,47 @@ -# Dubbo Extension向导 \ No newline at end of file +# Dubbo Extension向导 + +Dubbo使用微内核+插件的设计模式。内核只负责组装插件,Dubbo的功能都是由扩展点(插件)实现,这就意味着Dubbo的所有功能都可以被用户定制的扩展所替代。 + +### Dubbo生态系统 + +我们建议您将扩展加入到Dubbo生态系统。使用这种模式,可以使Dubbo的核心仓库更干净,并且可以减少维护工作。更少的代码也可以提高核心仓库的构建速度。 + +### 依赖 + +要实现您自己的Dubbo扩展,通常只需依赖API jar就可以满足您的需求。例如: + +```xml +<dependency> + <groupId>org.apache.dubbo</groupId> + <artifactId>dubbo-serialization-api</artifactId> + <version>${dubbo.version}</version> +</dependency> +``` + +### Src指导 + +通常,要实现特殊的扩展,只需要参考[开发者指南](http://dubbo.apache.org/#/docs/dev/build.md?lang=en-us),实现Dubbo必要的接口和合适的扩展即可。除此之外,还有一些其它的事项需要注意: + +1. 良好的测试,您需要编写单元测试和冒烟测试以消除潜在的bug。 +2. 没有警告,如有不可避免的警告,请使用@SuppressWarnings阻止它,但是请不要乱用。 +3. README。添加必要的自述以说明如何使用扩展,以及需要注意的事项。 +4. 许可证:请确保使用Apache License 2.0。 + +### 通知社区 + +1. 提交您的代码到[github](https://github.com)。 +2. 加入邮件列表(建议)。点击[这里](https://github.com/apache/incubator-dubbo/wiki/Mailing-list-subscription-guide)查看如何加入邮件列表。 +3. 发送一封邮件到d...@incubator.dubbo.apache.org通知社区。 +4. 通常,发送邮件之后,社区会对您的扩展进行讨论,dubbo组的管理员会联系您转移您的项目到dubbo生态系统。 + +### 转移项目到dubbo生态系统 + +1. dubbo组的管理员会请您将您的项目的所有者转让给dubbo。 +2. dubbo组的管理员会在dubbo组下新建一个项目并邀请您加入到这个项目。 +3. 一旦您接受邀请,您可以将您的项目转移到dubbo组下的新项目里。 +4. dubbo组的成员会对您的项目进行代码审查。随后,您可以对这些代码进行改进。 + + + + + diff --git a/docs/zh-cn/developers/contributor-guide/mailing-list-subscription-guide_dev.md b/docs/zh-cn/developers/contributor-guide/mailing-list-subscription-guide_dev.md index ff44886..62fd7c2 100644 --- a/docs/zh-cn/developers/contributor-guide/mailing-list-subscription-guide_dev.md +++ b/docs/zh-cn/developers/contributor-guide/mailing-list-subscription-guide_dev.md @@ -1 +1,78 @@ -# 邮件列表订阅向导 \ No newline at end of file +# 邮件列表订阅向导 + +Apache incubator的Dubbo开发者邮件列表(d...@dubbo.incubator.apache.org)已经建立,请随时订阅并参考[1]获取更多细节。 + +下面是一个关于Dubbo邮件列表订阅的简短指南: + +1. 发一封邮件到dev-subscr...@dubbo.incubator.apache.org,其内容和标题均可为空。随后,您会收到一封邮件,其内容如下: + +``` +from: dev-h...@dubbo.apache.org +reply-to: dev-sc.xxxxxxx.xxxxxxxx-hello=example....@dubbo.apache.org +to: he...@example.com +date: Sat, Feb 24, 2018 at 3:12 PM +subject: confirm subscribe to d...@dubbo.apache.org +mailed-by: apache.org + +Hi! This is the ezmlm program. I'm managing the +d...@dubbo.apache.org mailing list. + +I'm working for my owner, who can be reached +at dev-ow...@dubbo.apache.org. + +To confirm that you would like + + he...@example.com + +added to the dev mailing list, please send +a short reply to this address: + + dev-sc.xxxxxxx.xxxxxxxx-hello=example....@dubbo.apache.org + +Usually, this happens when you just hit the "reply" button. +If this does not work, simply copy the address and paste it into +the "To:" field of a new message. + +or click here: + mailto:dev-sc.xxxxxxx.xxxxxxxx-hello=example....@dubbo.apache.org + +... +``` + +2. 直接回复邮件,其内容和标题仍然可以为空,随后,您将再次收到一封邮件,其内容如下: + +``` +from: dev-h...@dubbo.apache.org +to: he...@example.com +date: Sat, Feb 24, 2018 at 3:14 PM +subject: WELCOME to d...@dubbo.apache.org +mailed-by: apache.org + +Hi! This is the ezmlm program. I'm managing the +d...@dubbo.apache.org mailing list. + +I'm working for my owner, who can be reached +at dev-ow...@dubbo.apache.org. + +Acknowledgment: I have added the address + + he...@example.com + +to the dev mailing list. + +Welcome to d...@dubbo.apache.org! + +Please save this message so that you know the address you are +subscribed under, in case you later want to unsubscribe or change your +subscription address. + +... +``` + +3. 到此,邮件列表订阅完毕,从现在开始,您将收到很多发送到该邮件列表的邮件,如果您有更多的问题,只需发送邮件到d...@dubbo.incubator.apache.org,就会有人回答您的问题。 + +4. 如果您想取消订阅,只需发送一封邮件到dev-unsubscr...@dubbo.incubator.apache.org,收到回复后,请按其指定步骤执行。 + +> 请注意:d...@dubbo.apache.org和d...@dubbo.incubator.apache.org都是有效的, 您可以订阅它们中的任何一个。 + +[1] http://apache.org/foundation/mailinglists.html#subscribing \ No newline at end of file diff --git a/docs/zh-cn/developers/contributor-guide/software-donation-guide_dev.md b/docs/zh-cn/developers/contributor-guide/software-donation-guide_dev.md index 045e8ff..406db49 100644 --- a/docs/zh-cn/developers/contributor-guide/software-donation-guide_dev.md +++ b/docs/zh-cn/developers/contributor-guide/software-donation-guide_dev.md @@ -1 +1,112 @@ -# 软件捐献向导 \ No newline at end of file +# 软件捐献向导 + +在您阅读这篇指南之前,请确保您已经向PPMC确认了实际需要的SGA。 + +如果您向Apache Dubbo(incubating)捐赠了大量的代码或文档,则需要在合并代码或者文档之前签署[软件授权书](https://www.apache.org/licenses/#grants)。 + +### 操作步骤 + +1. 下载这篇[pdf文档](https://www.apache.org/licenses/software-grant-template.pdf) + +2. 打印下载好的文档 + +3. 按要求填充表格(请看下边示例) + +4. 请您的领导在上边签字 + +5. 扫描 + +6. 将扫描好的文档以邮件的方式发送给secret...@apache.org,并抄送给priv...@dubbo.apache.org + +### 示例 + +下边是一个文本示例,原始文本可以在[这里](https://www.apache.org/licenses/software-grant.txt)找到 + +``` +License Agreement + + + This License Agreement is entered into as of the _12th_ day of +___April____, __2018__ by ___ABC Software Co., Ltd.____ ("Licensor"), +in favor of The Apache Software Foundation, a Delaware nonstock +membership corporation (the "Foundation"). + + WHEREAS, Licensor owns or has sufficient rights to contribute the +software source code and other related intellectual property as +itemized on Exhibit A ("Software") under the terms of this agreement +to the Foundation for use within Foundation software development +projects ("Projects"). + + NOW, THEREFORE, FOR GOOD AND VALUABLE CONSIDERATION, the receipt +and legal sufficiency of which are hereby acknowledged, the parties +hereto, intending to be legally bound, agree as follows: + +1. Subject to the terms and conditions of this License, Licensor +hereby grants to the Foundation: + + a) a non-exclusive, worldwide, royalty-free, irrevocable + copyright license to reproduce, prepare derivative works of, + publicly display, publicly perform, distribute and sublicense, + internally and externally, the Software and such derivative + works, in source code and object code form; and, + + b) a non-exclusive, worldwide, royalty-free, irrevocable + patent license under Licensed Patents to make, use, sell, + offer to sell, import and otherwise transfer the Software + in source code and object code form. "Licensed Patents" mean + patent claims owned by Licensor which are necessarily + infringed by the use or sale of the Software alone. + +2. Licensor represents that, to Licensor's knowledge, Licensor is +legally entitled to grant the above license. Licensor agrees to notify +the Foundation of any facts or circumstances of which Licensor becomes +aware and which makes or would make Licensor's representations in this +License Agreement inaccurate in any respect. + +3. This Software is provided AS-IS, WITHOUT WARRANTIES OR CONDITIONS +OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, WITHOUT LIMITATION, +ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY +OR FITNESS FOR A PARTICULAR PURPOSE. NEITHER THE LICENSOR NOR ITS +SUPPLIERS WILL BE LIABLE TO THE FOUNDATION OR ITS LICENSEES FOR ANY +DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED +AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, +OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF +THE USE OR DISTRIBUTION OF THE WORK OR THE EXERCISE OF ANY RIGHTS +GRANTED HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. + +This License Agreement is the entire agreement of the parties +with respect to its subject matter, and may only be amended by a +writing signed by each party. This License Agreement may be +executed in one or more counterparts, each of which shall be +considered an original. + + IN WITNESS WHEREOF, Licensor has executed this License Agreement +as of the date first written above. + + + LICENSOR: + + + Signed By: _____________________________________ <--- Your boss's sign here + + Print Name: _____Lei Li_________________________ <--- Your boss's name here + + Title: ____Director_____________________________ <--- Your boss's title here + + Representing: ____ABC Software Co., Ltd. _______ + + ________________________________________________ + + Contact Name: ____Lei Li________________________ <--- Your boss's name here + + Contact Email: ____lilei@abc.com________________ <--- Your boss's email here + +Exhibit A + +List of software and other intellectual property covered by this agreement: + +* Github address where your code is hosted +* Pull request link +``` + diff --git a/docs/zh-cn/developers/user-guide/faq_dev.md b/docs/zh-cn/developers/user-guide/faq_dev.md index 32cce90..89c16f2 100644 --- a/docs/zh-cn/developers/user-guide/faq_dev.md +++ b/docs/zh-cn/developers/user-guide/faq_dev.md @@ -1 +1,25 @@ -# FAQ \ No newline at end of file +# FAQ + +### dubbo-admin在哪里? + +从Dubbo 2.6.1版本开始,dubbo-admin已经从核心库迁移到https://github.com/apache/incubator-dubbo-ops + +### 我应该选择哪个版本? + +目前,dubbo保持着3个版本的并行推进: + +* 2.7.x (master) :要求java 1.8,重要功能分支。 +* 2.6.x:要求java 1.6,次要功能、bug修复分支,GA,生产准备。 +* 2.5.x:要求java 1.6,维护分支,只接受具有安全漏洞和致命性错误的bugfix,该分支预计很快就会停止维护 + +点击[这里](https://github.com/apache/incubator-dubbo/issues/1208)以了解更详细的版本管理计划。 + +对于贡献者,请确保所有的变更都提交到正确的分支上,也就是说,大多数的pull request都必须提交到2.7.x上,如有必要,将其反向合并到2.6.x和2.5.x上,如果是针对指定分支的bugfix,也请确保您的pull request提交到了正确的分支上。 + +对于提交者,请给每一个PR选择正确的标签和分支,如有必要,也请不要忘记将bugfix反向合并到低版本分支 + +### 如何在docker中正确地注册ip? + +[示例问题](https://github.com/alibaba/dubbo/issues/742) + +Dubbo支持通过配置系统环境参数的方式指定ip/port,点击[这里](https://github.com/dubbo/dubbo-samples/tree/master/dubbo-samples-docker)可以查看详细示例。 \ No newline at end of file