8 Star 41 Fork 48

EdgeGallery / docs

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

文档

## 介绍 仓库的文档由文档工具文档编译形成,链接如下:http://docs.edgegallery.org/zh_CN /最新的/

该文档目前包含以下内容:

##版权 Apache 许可证版本 2.0

知识共享公司 4.0(CC-BY-4.0)

Docs repo 提交的必要步骤

在 docs 存储库的 .md 文件中进行更改后,必须遵循以下步骤才能使相同的翻译工作。即使 .md 文件是用英文编写的,也必须遵循这些步骤,以保持正确的翻译结构

###环境要求

  • Ubuntu 18.04 版本或更高版本
  • python3.8安装在ubuntu中

设置环境

第 1 步:安装 python 的虚拟环境 apt-get 更新 apt-get install python-virtualenv mkdir /opt/python/3.8 virtualenv -p /usr/bin/python3 /opt/python/3.8 源/opt/python/3.8/bin/activate

第 2 步:准备虚拟环境 在虚拟环境中安装 pip 最新版本 21.1.1 curl https://bootstrap.pypa.io/get-pip.py -o get-pip.py python3.8 get-pip.py 确保在虚拟环境中执行 'pip --version' 命令会产生一个输出版本 (3.8) swajan@swajan-IdeaPad-3-15ADA05:~/jans_work/docs/2605/sixth_commit/docs$ pip --version 来自 /home/swajan/jans_work/python3/3.8/lib/python3.8/site-packages/pip (python 3.8) 的 pip 21.1.1 (3.8) swajan@swajan-IdeaPad-3-15ADA05:~/jans_work/docs/2605/sixth_commit/docs$

第 3 步:Sphinx 工具安装

  • 进入 docs 代码目录,执行 cd docs/
  • 从 docs 目录运行 test_tools.sh 这将导致生成 .pot 文件、更新 .po 文件、创建 .mo 文件、中文 html 和英文 html 生成的文件目录 .pot 文件目录:docs/_build/gettext/ .po 文件目录:docs/locale/en/LC_MESSAGES/ 中文html目录:docs/build/html/ 英文 html 目录:docs/_build/html/en

第 4 步:翻译 对于 docs 项目中 .md 文件的每次更改,都会更新或创建 .po 文件,而 test_tools.sh 在第 3 步中运行。

按照以下步骤制作正确的翻译内容。 1.【填充空msgStr】(#Fill-the-empty-msgStr) 2.【修改模糊msgStr】(#Modify-the-fuzzy-msgStr) 3.【移除旧内容】(#Remove-the-old-content)

填充空的msgStr 在 docs/locale/en/LC_MESSAGES/ 中为相同的修改过的 .md 文件导航相应的 .po 文件。

对于 docs/Projects/User Management/User_Interfaces.md 中的更改,应修改 docs/locale/en/LC_MESSAGES/Projects/User Management/User_Interfaces.po

文件中的所有 msgId 都应该可以进行翻译。对于每个 msgId,应该在 msgStr 中给出翻译 在文件中搜索msgStr "",手动翻译msgId。 需要在 User_Interfaces.po 文件中转换的空 msgStr #: ../../Projects/User Management/User_Interfaces.md msgstr "邮箱地址" msgstr "" User_Interfaces.po 文件中 msgStr 的翻译内容 #: ../../Projects/User Management/User_Interfaces.md msgstr "邮箱地址" msgstr "电子邮件地址" 修改模糊msgStr .md 的修改行会使 .po 文件具有“模糊”内容,也应该正确翻译。

在 .po 文件中搜索 #,fuzzy #: ../../Projects/User Management/User_Interfaces.md:561 #,模糊 msgstr "注册前需要先获取图形验证码,应用评论通过verifyCode参数传递。" msgstr "注册前,需要图形验证码通过verifyCode参数。" 去掉包含#,fuzzy的那一行,重新翻译msgId,更新User_Interface.po文件中的msgStr #: ../../Projects/User Management/User_Interfaces.md:561 msgstr "注册前需要先获取图形验证码,应用评论通过verifyCode参数传递。" msgstr "注册前需要获取图文验证码,应用评论通过verifyCode参数传递。" 删除旧内容 在 .po 文件中搜索 #~删除下面这些以“#~”开头的行 #~ msgstr "邮箱地址" #~ msgstr "电子邮件地址" 第 5 步:验证

  • 在所有 .po 文件中保存更改后,再次运行 docs/ 目录下的 test_tools.sh
  • 进入docs/_build/html/en,验证对应的英文翻译的html文件

第 6 步:提交 在推送更改时,只提交在 .po.md 中所做的更改。忽略所有其他文件夹和文件。 `` 不要提交以下文件和文件夹。删除这些更改。

  1. 文档/_build
  2. 文档/构建
  3. docs/locale/en/LC_MESSAGES/*.mo ``

文档详情

该仓库的文档通过文档工具编译形成文档,链接如下:http://docs.edgegallery.org/zh_CN/latest/

该文档当前包含的内容如下:

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.

简介

The docs of EdgeGallery 展开 收起
Python 等 4 种语言
Apache-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
1
https://gitee.com/edgegallery/docs.git
git@gitee.com:edgegallery/docs.git
edgegallery
docs
docs
master

搜索帮助