Appium 【全民时刻】开源团队需要全体成员的帮助

易寒 · March 04, 2015 · Last by 易寒 replied at March 08, 2015 · 1677 hits

目前 Appium 的中文文档翻译工作已经全部完成,这次我们对 5 个目录中总共 34 个文件进行了全面的更新。
所有文档存放在 testerhome 的 github 上,现在需要大家帮助我们 review,检查错误,发现错误。

文档地址

时间

2015年3月5日到 3 月 7 日,时间为 2 天时间

关注点

语义不明,链接跳转出错,格式不正确,排版混乱等等。

owner

发现问题后,提交给谁?可以根据下面的各个目录的负责人 @ 他们,或者直接在 github 上提交问题

@chenhengjie123
writing-running-appium

@anikikun
appium-setup

@xuxu
contributing-to-appium

@tspring
advanced-concepts

@shixue33
about-appium
README.cn.md

为啥要做这件事

2 天过后,我们就要提交给 Appium 官方,到时候你就可以看到最新最好的 Appium 中文版文档,这其中就有你的功劳。

如果觉得我的文章对您有用,请随意打赏。您的支持将鼓励我继续创作!
共收到 35 条回复 时间 点赞

README.cn.md 否则不会渲染。

README.cn.md 里面 符号好奇怪。 一会英文的标点符号,一会中文的符号。

易寒 #3 · March 04, 2015 Author

@shixue33
1.README.cn.md 需要改为 README.md,可以自动识别该文件
2.README.cn.md 里面 符号好奇怪。 一会英文的标点符号,一会中文的符号。

README.cn.md
你不需要以任何方式重新编译或者修改你的 app,就可以在所有的平台上使用标准的自动化 APIs
=》
因为使用了标准的自动化 api,你不需要重新编译或者修改你的 app。

appium/docs/cn/writing-running-appium/network_connection.md 需要删掉吧?
@doctorq 这个文件是你创建的。
@chenhengjie123

writing-running-appium------------------appium-bindings.cn.md
1.启动 Activity

在当前应用中打开一个 activity 或者启动一个新应用并打开一个 activity 。 只能在 Android 上使用
建议修改为:
在当前应用中打开一个 activity 或者启动一个新应用并打开一个 activity 。(只能在 Android 上使用)

2.当前 Activity

只能在 Android 上使用 获取当前 activity。

建议同上格式,修改为:
获取当前 activity。(只能在 Android 上使用)

3.触摸动作 (TouchAction) / 多点触摸动作 (MultiTouchAction)

生成触摸动作的接口。这部分文档很快将会补充更多的内容进来。
建议修改为:

生成触摸动作的接口。(这部分文档很快将会补充更多的内容进来)

4.设置

从这里你可以找到获取/设置 appium 系统设置的示例代码。 想知道它如何工作,以及它支持哪些设置,请查看关于设置的文档

建议修改为:
从这里你可以找到获取/设置 appium 系统设置的示例代码。( 想知道它如何工作?以及它支持哪些设置?请查看关于设置的文档)

易寒 #8 · March 04, 2015 Author

#7 楼 @se7en 非常感谢

易寒 #10 · March 04, 2015 Author

#9 楼 @beerbox 谢谢
@anikikun谁翻译的,让其仔细看看

这篇我也不知道是谁翻译的,我对事不对人,请允许我讲真话:1. 标点很奇怪;2. 中英文混杂;3.有点工具翻译的味道。
也许你很忙,也许你 E 文不怎样。感谢你的付出!
但是:
既然我们花时间了,我想我们就要将其做好。
这也是我们测试人的宗旨。

易寒 #12 · March 04, 2015 Author

#11 楼 @beerbox 没事,尽管提,不然提到官网再出现这么多问题就麻烦了

#11 楼 @beerbox 嗯是的,其实要坚持,既然做了,就要做好的原则。

#9 楼 @beerbox
@doctorq
这篇我对过一遍的,拿捏中,没改完呢,所以没提交上去,这个还是旧的,前人留下的遗迹。

@anikikun troubleshooting.cn.md 这篇的 1.3.5 英文版我在搭源码环境的时候看过,明显和这个中文翻译版不一样的(内容上不一样,和翻译质量无关)。建议 review 的时候结合它的最新英文版一起 review。

#15 楼 @chenhengjie123 这篇我基本是重翻的了。因为 reset 那一块纠结中,明天我提交上去让大家一起 review。

#16 楼 @anikikun 阿里困困。。你好。。。

@xuxu
https://github.com/testerhome/appium/blob/master/docs/en/contributing-to-appium/appium-from-source.md

https://github.com/testerhome/appium/blob/master/docs/cn/contributing-to-appium/appium-from-source.cn.md

  1. 在工作之前请先看下我们的代码风格指南=>代码风格指南遗失链接
  2. 和一个用任和存在且兼容 Appium 的语言编写的测试脚本 => 错别字:任何
  3. Manually modify the element following  undersystem.privilege.taskport in your /etc/authorization file to . 手动将/etc/authorization 文件中的 下的system.privilege.taskport改为. => 翻译有误: 不是将system.privilege.taskport改为
  4. e.g., a test with the word "alert" in the name 例如,一个测试用” alert"在名称的单词 => 翻译不准确

https://github.com/testerhome/appium/blob/master/docs/en/contributing-to-appium/grunt.md

https://github.com/testerhome/appium/blob/master/docs/cn/contributing-to-appium/grunt.cn.md

  1. 默认使用 iPhone 6.1 模拟器的 SDK 来构建应用 => 在英文版本里,是 7.1:  builds apps using the iPhone 7.1 simulator SDK

https://github.com/testerhome/appium/blob/master/docs/en/contributing-to-appium/how-to-write-docs.md

https://github.com/testerhome/appium/blob/master/docs/cn/contributing-to-appium/how-to-write-docs.cn.md

  1. ### 用于第二级标题。 => 前文中说 “## 被用于写第二级标题”,### 也是二级标题吗?
  2. 请把代码块放在中心位置 例子: 中心 代码片段放在这里  => 例子需使用代码块标记?现在的例子看不出如何写出居中的文档

@zhuyi OK,谢谢指出错误!修改后会再仔细 review 一遍

链接需要统一,比如,文件名里需要.cn.吗?是不是应优先链接到对应的中文版本?下面是链接跳转出错:
1.https://github.com/testerhome/appium/blob/master/docs/cn/about-appium/intro.cn.md
请参见 platform support doc
参见 capabilities 文档
让我们回到 getting started doc

2.https://github.com/testerhome/appium/blob/master/docs/cn/advanced-concepts/migrating-to-1-0.cn.md
访问 Appium client list

3.https://github.com/testerhome/appium/blob/master/docs/cn/appium-setup/android-setup.cn.md
参照 server documentation (没有跳转到对应中文页面)
请看这里 page (没有跳转到对应中文页面)

4.https://github.com/testerhome/appium/blob/master/docs/cn/appium-setup/parallel_tests.cn.md
更多参数的解释详见 here

5.https://github.com/testerhome/appium/blob/master/docs/cn/appium-setup/platform-support.cn.md
请移步到 Running on OS X: iOS 
更多信息请移步 至 mobile web doc
hybrid doc 查看详情
请移步至 Running on OS X: Android
Running on Windows
或者 Running on Linux 获得
请移 步至 mobile web doc 获取更多详情
请移步至 hybrid doc 参考相关文档
更多详情请移步至 server args doc

6.https://github.com/testerhome/appium/blob/master/docs/cn/appium-setup/running-on-linux.cn.md
你可以在 server documentation 找到所有的命令行参数

7.https://github.com/testerhome/appium/blob/master/docs/cn/appium-setup/troubleshooting.cn.md
确保你是根据 README 里面的入门指南按部就班的
参照 setup instructions
see this doc for more information
详见 文档
参见 mobile: findAndAct finding elements doc page

8.https://github.com/testerhome/appium/blob/master/docs/cn/writing-running-appium/appium-bindings.cn.md
请查看关于设置的文档 (没有跳转到对应中文页面)

9.https://github.com/testerhome/appium/blob/master/docs/cn/writing-running-appium/mobile-web.cn.md
具体可以参考 (hybrid docs

10.https://github.com/testerhome/appium/blob/master/docs/cn/writing-running-appium/running-tests.cn.md
Python(ms 是 url 不对,中文版链接到:
https://github.com/appium/sample-code%20/tree/master/sample-code/examples/python 英文版链接到:
https://github.com/appium/sample-code/tree/master/sample-code/examples/python)
Java 同上
参考 (Windows,Mac,or Linux
没有安装 Google 的用户界面自动化框架/UiAutomator framework.(ms 是 url 不对,中文版链接到:
http://developer.android.com/tool%E2%80%8B%E2%80%8Bs/help/uiautomator/index.html
英文版链接到:
http://developer.android.com/tools/help/uiautomator/index.html)

11.https://github.com/testerhome/appium/blob/master/docs/cn/README.md
你可以检查这个文件迁移到 1.0(没有跳转到对应中文页面)
Ensure you read our documentation on setting yourself up for iOS testing!
不同系统的环境 linux
osx
windows
首先还需要指定特定移动平台相关的 desired capabilities 
请参考 finding elements
 JSON Wire Protocol for automating mobile gestures 
HTML5 构建的 Web 页面 hybrid app guide 
地址包含了 很多不同语言的测试例子
Credits
我们增加了一个 问题定位指南.

易寒 #21 · March 05, 2015 Author

#20 楼 @zhuyi 非常感谢你帮助

@doctorq 所有中文文档的名称是否需要加 cn?如 README.md 翻译后文件名改为: README.cn.md

易寒 #23 · March 05, 2015 Author

#22 楼 @chenhengjie123 这个文档特殊,因为会自动展现这个文档,比如写成 READEME.md

@doctorq 我明白。我的意思是我们翻译后的文档是否都要统一加上 cn?
如果统一加上的话,就必须对所有链接到其他文档的链接进行修改,因为文件名不一样了。
个人建议用回原来的名字,不加 cn,理由就是 README.md 不能加 cn,为了保持统一全部都不加好了。

易寒 #25 · March 05, 2015 Author

#24 楼 @chenhengjie123 那你看看有多少是因为加了 cn 造成的?链接出错的问题主要原因是路径的问题,有的人直接把英文文档的链接地址都没有改,直接用的。而不是加了 cn 造成的,这个不需要改。修改一个东西你得考虑它是否能够解决根本问题。

易寒 #26 · March 05, 2015 Author

#24 楼 @chenhengjie123 等所有人把路径问题解决了,提交之前哪怕再改都没关系,现在的问题是很多根本没有去 check 这个路径正不正确。这不是我们命令规范造成的。

@doctorq 那天提交前我还好想起所有的链接应该指向已翻译的链接。。

易寒 #28 · March 05, 2015 Author

#27 楼 @xuxu 但是没人去做啊......

appium-setup 部分进行了小的更新。欢迎 review 提 BUG 共同改进。

#29 楼 @anikikun
https://github.com/testerhome/appium/blob/master/docs/cn/appium-setup/android-hax-emulator.cn.md

  1. 翻译不一致: 如果你发现 android 虚拟机太慢 => android 模拟器
  2. 错别字: 在 Inter 官方网站 => Intel

https://github.com/testerhome/appium/blob/master/docs/cn/appium-setup/android-setup.cn.md

  1. 中英文标点符号混合使用,应统一使用中文标点符号。
  2. 缺少空格: 运行'android'tool => 'android' tool(tool 前应该有一空格,参见英文版本)
  3. 改进:设置 Android SDK 的路径为 $ANDROID_HOME 的环境变量。如果你将 Android SDK 解压到 /usr/local/adt/,你需要把这个路径加到你的 shell 环境变量中去,例如:export ANDROID_HOME="/usr/local/adt/sdk" => 将环境变量 $ANDROID_HOME 设置为 Android SDK 的路径。例如,如果你将 Android SDK 解压到 /usr/local/adt/,你需要把下面这个命令加到你的 shell 启动中去: export ANDROID_HOME="/usr/local/adt/sdk"
  4. 改进: 如果你的 android 低版本 2.3 到 4.1 用到了 selendroid,请设置 internet 权限在 APP 中.=> 如果你在使用 selendroid 或者低版本的 android(如版本 2.3 到 4.1),请确保你的 App 已设置 internet 权限。

https://github.com/testerhome/appium/blob/master/docs/cn/appium-setup/ios-deploy.cn.md

  1. 专用名词的大小写错误:部署 ios app 到手机上 => iOS
  2. 错别字:在 node 服务启动前 fruitstrap 进行需要被结束=>作者可能想写 “进程”,而不是 “进行”

https://github.com/testerhome/appium/blob/master/docs/cn/appium-setup/parallel_tests.cn.md

  1. 专用名词的大小写错误: IOS => iOS

https://github.com/testerhome/appium/blob/master/docs/cn/appium-setup/platform-support.cn.md

  1. 有多余空格或换行或字符: a) 混合应用、内嵌 浏览器=>“内嵌” 和 “浏览器” 之间有多余空格 b) 对于 真机 c) 更多信息请移步 至 mobile web doc=>“移步” 和 “至” 之间有多余空格 d) 更多详情请移步至 hybrid doc 查看详情=>“更多详情请移步至” 和 “hybrid doc 查看详情” 之间有多余换行 e) 支 持和安装配置文档=>“支” 和 “持” 之间有多余空格 f) 类 库支持 g) 实 现自动化测试的 h) Selendroid 拥有 d 一套不同=>拥有一套不同 i) 4.4+ 版本的 出现 j) 但是 需要在测试设备环境 k) 但是不支 持使用 Selendroid  l) 必 须要启动另一个端口 j) 但是不支持 Selendroid 后台 运行的场景
  2. 错别字: 使用 Appimu 时候支持=> Appium
  3. 原文有更新;and 未被翻译: 版本号:6.1 , 7.0 , and 7.1 =>版本号:6.0,6.1,7.0,7.1, 8.0 和 8.1
  4. 原文有更新: a) iOS 系统下使用 Appium 的必备条件和安装说明,英文版本有 9 条,中文版本是 8 条,最后一条没有翻译。 b) Android 平台下的最后一条没有翻译 我参考的是https://github.com/testerhome/appium/blob/master/docs/en/appium-setup/platform-support.md
  5. 翻译不一致:Support for automating multiple apps in one session,这一句在 “iOS 平台支持” 里被翻译为 “是否支持在同一个 session 中的支持多种应用自动化”,而在 “Android 平台” 里被翻译为 “是否支持在一个 session 里的多个应用自动化” 请检查别的条目,例如,“Support for automating multiple devices simultaneously” 这一条也是有同样问题。
  6. 中英文标点符号混合使用,应统一使用中文标点符号;有标点用错的情况,可以统一检查下。

#30 楼 @zhuyi 感谢反馈!太细致了!!!

@beerbox @lifreshman @lipijin 兄弟们我们各自对一下自己的那版。

各位辛苦

#30 楼 @zhuyi 感谢反馈 辛苦!

README.cn.md 我周一会提交个版本。

易寒 #35 · March 08, 2015 Author

#34 楼 @lihuazhang 嗯?恒温大哥也要参加进来?

需要 Sign In 后方可回复, 如果你还没有账号请点击这里 Sign Up