Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

修正与源码不匹配的文档说明/加入订阅邮件列表 #261

Merged
merged 9 commits into from
Jan 28, 2019
Merged
Prev Previous commit
Next Next commit
Revert "修复一些中文语法不通顺的问题"
This reverts commit 67e1d5c
  • Loading branch information
hejia committed Jan 16, 2019
commit cd794ca8f7b5d01a3c7dc319fe3c47ab943bb14b
2 changes: 1 addition & 1 deletion zh-cn/docs/dev/checklist.html
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ <h2>修复时 checklist</h2>
<h2>Partner Check</h2>
<ul>
<li>Partner 以用户的方式运行一下功能</li>
<li>Partner 发现问题、添加测试(集成测试)直到不再复现;Owner 完成实现。(保证两方在Partner Check上的时间投入)</li>
<li>Partner 发现问题、添加测试(集成测试)复现总是;Owner 完成实现。(保证两方的时间投入 PatternerCheck 的给予时间保证)</li>
<li>Owner 向 Partner 讲述一遍实现。</li>
</ul>
</div></section><footer class="footer-container"><div class="footer-body"><img src="/img/dubbo_gray.png"/><img class="apache" src="/img/apache_logo.png"/><div class="cols-container"><div class="col col-12"><h3>Disclaimer</h3><p>Apache Dubbo is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Incubator. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF.</p></div><div class="col col-4"><dl><dt>ASF</dt><dd><a href="http://www.apache.org" target="_self">基金会</a></dd><dd><a href="http://www.apache.org/licenses/" target="_self">证书</a></dd><dd><a href="http://www.apache.org/events/current-event" target="_self">事件</a></dd><dd><a href="http://www.apache.org/foundation/sponsorship.html" target="_self">赞助</a></dd><dd><a href="http://www.apache.org/foundation/thanks.html" target="_self">致谢</a></dd></dl></div><div class="col col-4"><dl><dt>文档</dt><dd><a href="/zh-cn/docs/user/quick-start.html" target="_self">快速开始</a></dd><dd><a href="/zh-cn/docs/dev/build.html" target="_self">开发者指南</a></dd><dd><a href="/zh-cn/docs/admin/ops/dubbo-ops.html" target="_self">运维管理</a></dd></dl></div><div class="col col-4"><dl><dt>资源</dt><dd><a href="/zh-cn/blog/index.html" target="_self">博客</a></dd><dd><a href="/zh-cn/community/index.html" target="_self">社区</a></dd><dd><a href="https://www.apache.org/security" target="_self">安全</a></dd></dl></div></div><div class="copyright"><span>Copyright © 2018-2019 The Apache Software Foundation. Apache and the Apache feather logo are trademarks of The Apache Software Foundation.</span></div></div></footer></div></div>
Expand Down
2 changes: 1 addition & 1 deletion zh-cn/docs/dev/checklist.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"filename": "checklist.md",
"__html": "<h1>检查列表</h1>\n<h2>发布前 checklist</h2>\n<ul>\n<li>jira ticket 过一遍</li>\n<li>svn change list</li>\n<li>ticket 关联 code</li>\n<li>test code</li>\n<li>find bugs</li>\n</ul>\n<h2>修复时 checklist</h2>\n<ul>\n<li>修复代码前先建 ticket</li>\n<li>修复代码前先写测试用例</li>\n<li>需要伙伴检查</li>\n<li>test code(正常流程/异常流程)</li>\n<li>讲一遍逻辑</li>\n<li>契约文档化</li>\n<li>以上内容都写到ticket的评论上</li>\n<li>代码注释写清楚,用中文无妨</li>\n<li>每个版本要有 owner,确保 scope 和 check</li>\n</ul>\n<h2>Partner Check</h2>\n<ul>\n<li>Partner 以用户的方式运行一下功能</li>\n<li>Partner 发现问题、添加测试(集成测试)直到不再复现;Owner 完成实现。(保证两方在Partner Check上的时间投入)</li>\n<li>Owner 向 Partner 讲述一遍实现。</li>\n</ul>\n",
"__html": "<h1>检查列表</h1>\n<h2>发布前 checklist</h2>\n<ul>\n<li>jira ticket 过一遍</li>\n<li>svn change list</li>\n<li>ticket 关联 code</li>\n<li>test code</li>\n<li>find bugs</li>\n</ul>\n<h2>修复时 checklist</h2>\n<ul>\n<li>修复代码前先建 ticket</li>\n<li>修复代码前先写测试用例</li>\n<li>需要伙伴检查</li>\n<li>test code(正常流程/异常流程)</li>\n<li>讲一遍逻辑</li>\n<li>契约文档化</li>\n<li>以上内容都写到ticket的评论上</li>\n<li>代码注释写清楚,用中文无妨</li>\n<li>每个版本要有 owner,确保 scope 和 check</li>\n</ul>\n<h2>Partner Check</h2>\n<ul>\n<li>Partner 以用户的方式运行一下功能</li>\n<li>Partner 发现问题、添加测试(集成测试)复现总是;Owner 完成实现。(保证两方的时间投入 PatternerCheck 的给予时间保证)</li>\n<li>Owner 向 Partner 讲述一遍实现。</li>\n</ul>\n",
"link": "/zh-cn/docs/dev/checklist.html",
"meta": {}
}
10 changes: 5 additions & 5 deletions zh-cn/docs/dev/release.html
Original file line number Diff line number Diff line change
Expand Up @@ -22,28 +22,28 @@ <h2>2 个版本并行开发</h2>
<p><code>2.5.x</code> 的新功能基本稳定后,进入 <code>2.5.x</code> 试用阶段。找足够多的应用试用 <code>2.5.x</code> 版本。</p>
<p>在 <code>2.5.x</code> 够稳定后:</p>
<ul>
<li><code>2.5.x</code> 成为 GA 版本,只 BugFix,推广使用此版本。如果可行,可以推进应用在期望的时间点内升级到 GA 版本。</li>
<li><code>2.5.x</code> 成为 GA 版本,只 BugFix,推广使用此版本。如何可行,可以推进应用在期望的时间点内升级到 GA 版本。</li>
<li><code>2.4.x</code> 不再开发,应用碰到 Bug 让直接升级。(这个称为“夕阳条款”)</li>
<li>从 <code>2.5.x</code> 拉成分支 <code>2.6.0</code>,作为新功能开发版本。</li>
</ul>
<h2>优势</h2>
<ul>
<li>保证 GA 版本是稳定的!因为:
<li>保持 GA 版本是稳定的!因为:
<ul>
<li>只会作 BugFix</li>
<li>成为 GA 版本前有试用阶段</li>
</ul>
</li>
<li>新功能可以在高版本中快速响应,并让应用能试用新功能。</li>
<li>新功能可以高版本中快速响应,并让应用能试用新功能。</li>
<li>不会版本过多,导致开发和维护成本剧增</li>
</ul>
<h2>用户要配合的职责</h2>
<p>由于开发只会 BugFix GA 版本,所以用户需要积极跟进升级到 GA 版本,以 Fix 发现的问题。</p>
<p>定期升级版本给用户带来了不安。这是一个假命题,说明如下:</p>
<p>定期升级版本用户带来了不安。这是一个假命题,说明如下:</p>
<ul>
<li>GA 经过一个试用阶段保持稳定。</li>
<li>GA 版本有 Bug 会火速 Fix</li>
<li>相对出问题才升级到 GA 版本(可能跨了多个版本)定期升级平摊风险(类似小步快跑)。经历过周期长的大项目的同学会有这样的经历,三方库版本长时间不升级,结果出了问题不得不升级到新版本(跨了多个版本)风险巨大。</li>
<li>相对出问题才升级到 GA 版本(可以跨了多个版本)定期升级平摊风险(类似小步快跑)。经历过周期长的大项目的同学会有这样的经历,三方库版本长时间不升级,结果出了问题不得不升级到新版本(跨了多个版本)风险巨大。</li>
</ul>
</div></section><footer class="footer-container"><div class="footer-body"><img src="/img/dubbo_gray.png"/><img class="apache" src="/img/apache_logo.png"/><div class="cols-container"><div class="col col-12"><h3>Disclaimer</h3><p>Apache Dubbo is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Incubator. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF.</p></div><div class="col col-4"><dl><dt>ASF</dt><dd><a href="http://www.apache.org" target="_self">基金会</a></dd><dd><a href="http://www.apache.org/licenses/" target="_self">证书</a></dd><dd><a href="http://www.apache.org/events/current-event" target="_self">事件</a></dd><dd><a href="http://www.apache.org/foundation/sponsorship.html" target="_self">赞助</a></dd><dd><a href="http://www.apache.org/foundation/thanks.html" target="_self">致谢</a></dd></dl></div><div class="col col-4"><dl><dt>文档</dt><dd><a href="/zh-cn/docs/user/quick-start.html" target="_self">快速开始</a></dd><dd><a href="/zh-cn/docs/dev/build.html" target="_self">开发者指南</a></dd><dd><a href="/zh-cn/docs/admin/ops/dubbo-ops.html" target="_self">运维管理</a></dd></dl></div><div class="col col-4"><dl><dt>资源</dt><dd><a href="/zh-cn/blog/index.html" target="_self">博客</a></dd><dd><a href="/zh-cn/community/index.html" target="_self">社区</a></dd><dd><a href="https://www.apache.org/security" target="_self">安全</a></dd></dl></div></div><div class="copyright"><span>Copyright © 2018-2019 The Apache Software Foundation. Apache and the Apache feather logo are trademarks of The Apache Software Foundation.</span></div></div></footer></div></div>
<script src="https://f.alicdn.com/react/15.4.1/react-with-addons.min.js"></script>
Expand Down
2 changes: 1 addition & 1 deletion zh-cn/docs/dev/release.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"filename": "release.md",
"__html": "<h1>版本管理</h1>\n<p><strong>新功能的开发</strong> 和 <strong>稳定性的提高</strong> 对产品都很重要。但是添加新功能会影响稳定性,Dubbo 使用如下的版本开发模式来保障两者。</p>\n<h2>2 个版本并行开发</h2>\n<ul>\n<li>BugFix 版本:低版本,比如 <code>2.4.x</code>。是 GA 版本,线上使用的版本,只会 BugFix,升级第三位版本号。</li>\n<li>新功能版本:高版本,比如 <code>2.5.x</code>。加新功能的版本,会给对新功能有需求的应用试用。</li>\n</ul>\n<p><code>2.5.x</code> 的新功能基本稳定后,进入 <code>2.5.x</code> 试用阶段。找足够多的应用试用 <code>2.5.x</code> 版本。</p>\n<p>在 <code>2.5.x</code> 够稳定后:</p>\n<ul>\n<li><code>2.5.x</code> 成为 GA 版本,只 BugFix,推广使用此版本。如果可行,可以推进应用在期望的时间点内升级到 GA 版本。</li>\n<li><code>2.4.x</code> 不再开发,应用碰到 Bug 让直接升级。(这个称为“夕阳条款”)</li>\n<li>从 <code>2.5.x</code> 拉成分支 <code>2.6.0</code>,作为新功能开发版本。</li>\n</ul>\n<h2>优势</h2>\n<ul>\n<li>保证 GA 版本是稳定的!因为:\n<ul>\n<li>只会作 BugFix</li>\n<li>成为 GA 版本前有试用阶段</li>\n</ul>\n</li>\n<li>新功能可以在高版本中快速响应,并让应用能试用新功能。</li>\n<li>不会版本过多,导致开发和维护成本剧增</li>\n</ul>\n<h2>用户要配合的职责</h2>\n<p>由于开发只会 BugFix GA 版本,所以用户需要积极跟进升级到 GA 版本,以 Fix 发现的问题。</p>\n<p>定期升级版本给用户带来了不安。这是一个假命题,说明如下:</p>\n<ul>\n<li>GA 经过一个试用阶段保持稳定。</li>\n<li>GA 版本有 Bug 会火速 Fix</li>\n<li>相对出问题才升级到 GA 版本(可能跨了多个版本)定期升级平摊风险(类似小步快跑)。经历过周期长的大项目的同学会有这样的经历,三方库版本长时间不升级,结果出了问题不得不升级到新版本(跨了多个版本)风险巨大。</li>\n</ul>\n",
"__html": "<h1>版本管理</h1>\n<p><strong>新功能的开发</strong> 和 <strong>稳定性的提高</strong> 对产品都很重要。但是添加新功能会影响稳定性,Dubbo 使用如下的版本开发模式来保障两者。</p>\n<h2>2 个版本并行开发</h2>\n<ul>\n<li>BugFix 版本:低版本,比如 <code>2.4.x</code>。是 GA 版本,线上使用的版本,只会 BugFix,升级第三位版本号。</li>\n<li>新功能版本:高版本,比如 <code>2.5.x</code>。加新功能的版本,会给对新功能有需求的应用试用。</li>\n</ul>\n<p><code>2.5.x</code> 的新功能基本稳定后,进入 <code>2.5.x</code> 试用阶段。找足够多的应用试用 <code>2.5.x</code> 版本。</p>\n<p>在 <code>2.5.x</code> 够稳定后:</p>\n<ul>\n<li><code>2.5.x</code> 成为 GA 版本,只 BugFix,推广使用此版本。如何可行,可以推进应用在期望的时间点内升级到 GA 版本。</li>\n<li><code>2.4.x</code> 不再开发,应用碰到 Bug 让直接升级。(这个称为“夕阳条款”)</li>\n<li>从 <code>2.5.x</code> 拉成分支 <code>2.6.0</code>,作为新功能开发版本。</li>\n</ul>\n<h2>优势</h2>\n<ul>\n<li>保持 GA 版本是稳定的!因为:\n<ul>\n<li>只会作 BugFix</li>\n<li>成为 GA 版本前有试用阶段</li>\n</ul>\n</li>\n<li>新功能可以高版本中快速响应,并让应用能试用新功能。</li>\n<li>不会版本过多,导致开发和维护成本剧增</li>\n</ul>\n<h2>用户要配合的职责</h2>\n<p>由于开发只会 BugFix GA 版本,所以用户需要积极跟进升级到 GA 版本,以 Fix 发现的问题。</p>\n<p>定期升级版本用户带来了不安。这是一个假命题,说明如下:</p>\n<ul>\n<li>GA 经过一个试用阶段保持稳定。</li>\n<li>GA 版本有 Bug 会火速 Fix</li>\n<li>相对出问题才升级到 GA 版本(可以跨了多个版本)定期升级平摊风险(类似小步快跑)。经历过周期长的大项目的同学会有这样的经历,三方库版本长时间不升级,结果出了问题不得不升级到新版本(跨了多个版本)风险巨大。</li>\n</ul>\n",
"link": "/zh-cn/docs/dev/release.html",
"meta": {}
}