Tencent / APIJSON

🏆 实时 零代码、全功能、强安全 ORM 库 🚀 后端接口和文档零代码,前端(客户端) 定制返回 JSON 的数据和结构 🏆 Real-Time coding-free, powerful and secure ORM 🚀 providing APIs and Docs without coding by Backend, and the returned JSON of API can be customized by Frontend(Client) users
http://apijson.cn
Other
17.32k stars 2.16k forks source link

英文文档大量中文解析啊 #62

Open wgh815600709qq opened 5 years ago

wgh815600709qq commented 5 years ago

@小zhou - .- qaq

TommyLemon commented 5 years ago

你公司要用了吗?目前确认是国外的用户只有一个,英文文档就暂时搁置翻译了

ruoranw commented 5 years ago

hello,我可以帮助你们改进英文文档。请问需要这方面帮助吗?

TommyLemon commented 5 years ago

@ruoranw 你好,需要的,非常感谢^_^ 目前中文的文档主要是 3 个

首页简介 https://github.com/APIJSON/APIJSON 翻译了头部概览+简介;剩下 特点功能快速上手使用登记贡献者们我要赞赏 等未翻译 https://github.com/APIJSON/APIJSON/blob/master/Document-English.md

通用文档 https://github.com/APIJSON/APIJSON/blob/master/Document.md 已翻译 80% 左右,剩下 2.5 Requests3.1 Operation3.2 Function https://github.com/APIJSON/APIJSON/blob/master/Document-English.md

部署文档 https://github.com/APIJSON/APIJSON/tree/master/APIJSON-Java-Server https://github.com/APIJSON/APIJSON/tree/master/APIJSON-Android https://github.com/APIJSON/APIJSON/tree/master/APIJSON-iOS https://github.com/APIJSON/APIJSON/tree/master/APIJSON-JavaScript 都未翻译。

可以 Fork 这个项目后,修改完给主项目发 Pull Request, 具体步骤可以参考 https://www.zhihu.com/question/21682976/answer/79489643

然后我会合并这个 Pull Request 并把你加入 贡献者列表

ruoranw commented 5 years ago

好,明白。謝謝。

ruoranw commented 5 years ago

Hi TommyLemon, 我想问下现有英文版Readme中的 4.2 部分,貌似在中文版中没有?这个部分是否已经不适用了?

TommyLemon commented 5 years ago

@ruoranw 英文版 4.2 和 4.3 都是对应 Java 后端的使用文档,中文版是更详细的单独一个 Readme https://github.com/APIJSON/APIJSON/tree/master/APIJSON-Java-Server

英文版 4.4 和 4.5 都是对应 Android 客户端的使用文档,中文版也是单独一个 Readme https://github.com/APIJSON/APIJSON/tree/master/APIJSON-Android

ruoranw commented 5 years ago

@TommyLemon Ok,明白了。

ruoranw commented 5 years ago

Hi TommyLemon,

我正在着手写Readme,发现目前英文版本太冗长了,我认为将第二部分compare和第三部分Overview独立出来成为新的doc。 Readme只放简介和安装、测试、authors、license,etc. 目前我的构架是: 1, Introduction 两句话介绍,加Features 2,Getting started 包括后端安装(两种方法) 3,Running the test 安卓客户端test 4,Contributing 5,Versioning . . Authors等

TommyLemon commented 5 years ago

@ruoranw 可以的,赞。 中文版首页 Readme 也只有简洁的概览 https://github.com/APIJSON/APIJSON/blob/master/README.md

ruoranw commented 5 years ago

@TommyLemon hello,刚发了Readme的pull request。我接下来会做英文版的通用文档。

TommyLemon commented 5 years ago

@ruoranw 非常感谢,翻译得很专业哦👍 ps: 相比之下,原来我写的那个简直就是机翻 /笑哭

ruoranw commented 5 years ago

@TommyLemon , 谢谢你的信任和肯定O(∩_∩)O ,我下面还会写通用文档。未来项目如果需要文档更新,我还可以帮忙。:)

TommyLemon commented 5 years ago

@ruoranw 太好了,非常感谢

TommyLemon commented 5 years ago

@ruoranw 你好,非常感谢你的 通用文档翻译, 我在英文文档首页加了 Document 链接,关联到 documentation_eng.md https://github.com/APIJSON/APIJSON/blob/master/Document-English.md

TommyLemon commented 5 years ago

@ruoranw 你好,通用文档内容很多,难免会有些小问题,我发现并修正了一些文案和格式等问题。 https://github.com/APIJSON/APIJSON/commit/7440fa73e03dbb7a420e4db88f400fef18b4fe14

因为目前只提供 Moment 表,而没有对应的 Post 表,加上 Post 容易和 /post 接口以及 HTTP POST 请求方法混淆,所以我就改回 Moment 了 https://github.com/APIJSON/APIJSON/commit/6d720eeb0ad9ab0a73a345375844227472faa500

为了命名风格保持一致,我把 documentation_eng.md 重命名为 Document-English.md https://github.com/APIJSON/APIJSON/commit/dcdd24bcf5854a54dd4dc8411c5eacb225af2dc4

如果有什么问题,希望你反馈给我哦,再次感谢你的贡献 ^_^