2 Star 21 Fork 6

vertx-china / vertx-web-site

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Apache-2.0

vertx 4的官网翻译项目 Deploy

本地运行

本项目运行环境为node 16, python 2.7

翻译说明

如何认领

Issues 里面带 待认领 标签的都是 需要翻译的文档

请在想翻译的文档对应 issue 下面留言认领,我们会Assign给你,并修改issue标签等。

翻译注意事项

请 Fork 本项目再进行翻译。

除文档外,其他翻译直接翻译项目内的文件。

文档翻译需要翻译的是 docs/translation 目录。翻译完一个模块后,请在 docs/metadata/*.jsx 中搜索对应模块的简介并翻译(对应文档首页的简介)。

翻译原则上,建议中文段落和英文段落行数一致,这样在合并英文版本时,可以更清晰的发现文档中的冲突并解决。

目录的跳转是根据锚点来实现,但中文的标题处理的锚点似乎有问题,因此建议给所有标题添加上锚点,使页内跳转能正常运行。示例:

[[id]]
# 标题

使用<<id, 标题>>可以跳转到上面的标题处,其中id是锚点的id,“标题” 则是显示的内容。

英文文档里省略了id,直接使用了英文标题,但翻译成中文后,<<标题>> 中的中文标准就定位不了。因此需要按上述示例中那样来 精确定位。同时,为了确保中英文一致,建议这里的id使用官网上的id,具体方法就是点击官网上(或者在未翻译时在本地执行)的链接跳转后 使用地址栏#后面的内容,比如上面的示例,在地址栏中的链接应该是 http://localhost:3000/docs/xxx/#id

如果是通过 npm run dev 来预览的话,翻译完成后,刷新即可看到翻译后的文档。

新版本是预编译*.adoc文件的,因此翻译完成后,本地预览需要执行 npm run update-docs

新版本翻译在各版本目录下增加了 .cache.version 文件来控制缓存,修改完翻译后,修改此文件可以破坏缓存,从而让翻译的文件重新编译。

网络不好的情况下,可以修改 download.js 第 10 行 repoUrl 为阿里云(其他也可以)的镜像地址:https://maven.aliyun.com/repository/central

因为是以 index.adoc 文件来计算缓存的key,非 index.adoc 文件翻译后,如果不修改 index.adoc 文件,则不会更新缓存,页面也不会更新,需要在 index.adoc中进行小的修改

如何提交

提交翻译通过PR(Pull Request)进行。请在自己Fork的项目中发起PR,而不是本项目(本项目Fork了官方项目,若在本项目发起PR,默认会提交到官方项目)。

PR的描述中请注明对应的issue ID,如: 完成 #23 翻译

提交PR后,我们会分配 Reviewer; Review 文档给出的建议,可以:

  1. 直接在github页面对应修改意见里点击 Commit Suggestion 按钮直接提交;
  2. 在github页面对应修改意见里点击 Batch suggestion to batch,接受多个修改意见后,在上方的 Commit suggestions 统一提交;
  3. 也可以自己在本地修改后直接提交,然后在github页面对应修改意见里面点击 Resolve Conversation

image

image

如何 Review

分配Reviewer后Github会发送邮件,也可以主动到 PR 列表里找感兴趣的文档协助Review。

在具体PR页面里,点击 Files changed 标签页可以看到该PR的修改内容。在有修改意见或疑问的行,点击左边的加号,可以评论,或加入修改意见(点击 Insert a suggestion 按钮)。

review完毕后,点击左上角 Review changes,有三个选项:

  • Comment : 只提交评论
  • Approve : 觉得PR没问题,同意修改内容
  • Request Change : 觉得PR还需要进一步修改

分支说明

翻译只翻译master分支,因为创建的其他分支最终需要合并到master分支。

english分支与master分支的区别是:english 分支 的 translation目录为当前版本的英文文档。主要是版本升级时,更新英文文档时用。

版本更新操作说明

当vert.x发布新的版本,english分支需要更新为最新英文文档,而master分支需要将当前文档复制一份到 docs/translation/x.x.x 目录 中去,其中 x.x.x 为当前文档的版本。然后合并english分支到当前分支,并解决相应冲突。解决的方案如下

  1. 英文删除的。对应的翻译也删除(如果遵守了前面提到的英文行数和中文行数对应的话,应该比较好找到)
  2. 英文增加。因为没有翻译,所以保留英文部分,或者可以安排人立即翻译
  3. 英文修改。TODO 此处需要讨论之后定

english分支更新文档可合并 https://github.com/vertx-web-site/vertx-web-site 项目后,执行下面脚本来更新。

npm run copy-english

执行本命令前,请确保已经执行 npm run update-docs 更新了文档

Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, 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. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

简介

vertx 4的官网翻译项目 展开 收起
JavaScript 等 3 种语言
Apache-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
1
https://gitee.com/vertx-china/vertx-web-site.git
git@gitee.com:vertx-china/vertx-web-site.git
vertx-china
vertx-web-site
vertx-web-site
master

搜索帮助