Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP

Loading…

Sea.js 国际化 #809

Open
lifesinger opened this Issue · 36 comments
@lifesinger
Owner

等 2.1 发布后,可以考虑这件事了。主要要做的事:

  1. 文档国际化,推出英文版文档。
  2. 各个库的 README.md 详细点,可以跟英文文档结合。
  3. 到 CommonJS 等社区进行推广。
@wufeng87

厉害,国际化之后会有更多的挑战和机会。

@fundon

可以考虑到 Hacker News 进行推广

@smallsmallwolf

社区是不是也需要国际化?
比如,号召大家以后提 issue 发 pull request 什么的都用英文?
要不老外遇到问题来社区找,可能这个问题有人提过并且解决了,但是中文的,然后老外就只能再问一次了。

@lifesinger
Owner
@jiyinyiyong

把英文用户使用问题重定向到 StackOverflow, 中文到 SegmentFault
提供中英文 Wiki 和 FAQ, 然后更新常见问题中英文到 Wiki 和 FAQ 上?

貌似参与 PR, Issue 的老外无解...

@tcdona

英文用户使用问题重定向到 StackOverflow, 中文到 SegmentFault 这主意太亮了

@atans

感覺 seajs 比 requirejs 好幾條街,快推廣出去

@jiyinyiyong

这几天看下来, Browserify 是那种熟悉了 Node 写脚本的人十几分钟过一下命令就能上手的,
对应就是一个 README 入门, 几篇博客熟悉, 外加一个视频看下就清楚怎么用就清楚了
SeaJS 从模块化加载, 到部署, 以及各种插件, 外加 Grunt 使用,,
就在猜整个下来文档数量会很多, 要忙很久才能搞定吧

@fundon

seajs-v2.1.1 推到 bower 了
#863

@Hao-Wu

国际化确实十分重要,需要认真考虑。

可以预期国际化完善后,来自外国友人PR的活跃度会大大提高。

@gyf19

@lifesinger 建议 seajs 与 cocos2d-html5 官方合作。 cocos2d国际的开发者不少。 cocos2d-html5也是国人作品,可以很好沟通。 这样可以很好推广seajs 。

@gyf19

他们也在做对Require.js 支持。 cocos2d/cocos2d-html5#959

@lifesinger
Owner
@gyf19

@lifesinger 可以在新浪微博找 @林顺Sean 。他是 cocos2d-html5 作者

@gyf19

@lifesinger 昨天在微博联系@林顺,他很快回复我。 cocos2d-html5 项目也尝试过seajs,很好的机会呀。 两方可以尽快合作, 造福社会。

林顺Sean:多谢肯定。乐于接受吐槽。seajs,requirejs都曾经试过,还未全弄完。grunt,NPM,这些方式的结合正在做。预计下个版本启动download builder的工作,可以定制模块,更小的地址,更灵活的引用方式。 (11月7日 16:27)

@atans

seajs.org 好像还没有英文版

@willkan

建议先将seajs的api独立成一个网站,在issues里查api真心用户体验差

@lizzie
Collaborator

@willkan seajs 一共就那么几个 API, 还折腾什么独立网站啊. 几句话就能说清楚的事情...费神搞什么用户体验啊

@afc163
Owner

@willkan 你这github自动生成的头像真是高上大,比设计过的还好。

@willkan

@afc163 我不知道我的话有哪些不敬,如有不敬,我道歉.我也是seajs的忠实粉丝,只是我自己真的在找seajs的api的过程中有不少麻烦,我只是提个建议.我说网站可能有点夸张,我觉得一个重新布置的github page也会给api查找带来很大的便利

@hotoo
Collaborator

@willkan 你说的非常对。我们会尽快对这些做出改进,也期待你参与共同贡献 :)

@afc163
Owner

。。。我又没说什么。

  1. seajs 的 API 的确很少,不像 jQuery 那样需要经常性的查阅。

  2. 文档风格这个玩意因人而异啊,换成啥样都有人吐槽。jQuery 的官方文档就很多人不喜欢,然后自己做了很多 API 文档。作为开源项目,如果不喜欢这风格,自己做一份贡献出来。比如这个家伙就自己折腾了一份:http://jiyinyiyong.github.io/seajs-issues/ 虽然他做的东西没啥意义。。。

@lifesinger
Owner
@jiyinyiyong

@afc163 marked API 更改, highlight.js 代码报错. Ractive 也出点问题, CDN 上的 markdowncss 意外生效..
紧张修补中.. >_<


update

备用地址 http://repo.jiyinyiyong.me/seajs-issues/

@afc163
Owner

我感觉是好多人不知道 http://seajs.org/docs/#docs 这个地址,以为要到 issues 中去翻找?

@lifesinger
Owner

@afc163 同感,为什么大家找不到这个地址?Sea.js 2.2 我把 seajs.org 改下版试下。

@willkan

首先真的很感谢各位的贡献,文档从seajs1.3到现在真的好了很多
但从 http://seajs.org/docs/#docs 跳转到seajs上的issue,然后又issue跳转到子issue,但很重要的是子issue没法跳回父issue更没法跳回 http://seajs.org/docs/#docs 这让整个api看起来毫无连贯性
@lifesinger 提到了node的文档页,我觉得node的文档页就真的不错,主目录子目录间连贯的跳转,然后文档也是多人贡献的(也是通过github讨论),可以挑出更好的文档用语

然后

在于使用者有没有静下心来至少看过「基础」部分的文档

这里我说一下我刚接触seajs的时候也没有静下心来把这些全看完,就算是后来一次看完也只是有点印象,没有完全理解.边看边写可能这就是新手(那时还不懂cmd)的心态,而seajs的基础部分不能让新手连贯地边看边写取理解,也就造成了我觉得seajs文档有待改善

不知我说的对不对,就一个建议

@lifesinger
Owner

seajs的基础部分不能让新手连贯地边看边写取理解

嗯,这个的确是问题。但这个往往需要靠社区来贡献,原作者由于太熟悉sea.js,往往很难写出来。一直期待有人给 sea.js 贡献一份举世皆赞的新手文档,但等啊等一直没等到,悲催ing

@jiyinyiyong

个人观点, define require exports 语法因为有 Node 基础上手非常快,
但摸了几个月才 RequireJS 上服务器, 现在没在生产环境使用 SeaJS.. 我的想法是:

对比 Node, RequireJS, Grunt, 访问 SeaJS 的文档很不方便,
Github 的 Issue 里没有 Backbone 式的每个 API 二级导航, 显得不清晰.

缺少很多清晰的用例(也许某个地方有...), 用来在新手理解歪了, 或者搞不清具体语法时参考,
如果官方有给某些相对复杂的例子清晰的 Demo, 新手照抄, 然后理解代码, 就能避免很多麻烦,
而且比如打包相对复杂的情况.. 我看了很久才理清楚, 最后 RequireJS 都是参照网上例子搞出来的

实际学习时候, 因为涉及到怎样使用别人的模块和提供给别人模块, 这中间也糊涂了不少时间
我没选用 SeaJS 一个原因是国外很多模块并不支持 SeaJS 的加载,
RequireJS 也有这套简化语法, 而且支持模块多, 我还没熟练 SeaJS, 不想冒风险.

介绍 SeaJS 使用的博客不够多, 很有种在网上搜着别的前端问题, 就遇到 RequireJS 了,
相对地 SeaJS 却很少遇到这样的热情, 微博, SegmentFault, V2EX 上前端也算多, 很少看到 SeaJS.
表示作为新手我就这样, 那个技术看起来前景好就关心哪个, 刚开始才不管谁代码写得好.

我个人觉得给新手需要更多还是例子, 和各种报错如何处理,
文档等到有复杂问题了想挖代码看时候, 能找到对应的资源也就好了.

@lei-cao

@lifesinger :

最近希望学习一下 SeaJS 同时把英文文档翻译出来(如果还没有人来做的话).
之前翻译了 http://beego.me 的所有英文文档和其他网站内容. Beego 的文档直接就在 repo 里面, 都是 markdown 格式, 然后通过 beeweb 自动把 beedoc 的 repo 渲染出来. 我直接 fork 翻译. 或者直接连接到 github 网站直接修改 commit. 然后有 hook 自动更新 beeweb 网站的内容. 使用起来还是很方便的.

但是看了 SeaJS 的, 貌似文档现在都是在 issue 里面. 大家看看有什么好的其他办法把这个文档国际化的事情推动一下? 把文档国际化翻译的流程简化一下. 如果觉得 beeweb beedoc 这套东西合适用, 我可以帮忙搭建~~ 现在和 https://github.com/astaxie 混, 有问题可以直接请教他. :smile:

@zuibunan

希望先把中文文档搞好,现在官网基本就是个摆设,什么东西都在github上,太分散了
另外seajs的功能经常变,建议加个更新记录,列出每个版本的变动,废除了什么,添加了什么,更新了什么等等

@afc163
Owner

@zuibunan 我想说一直都有更新记录:http://seajs.org/docs/#downloads 文档也一直分门别类的循序渐进的放在这里:http://seajs.org/docs/#docs 。只是你们都懒得去找。

@msdlisper

说到国际化,我又想起好多jquery插件都支持amd,为了引入这些插件还要自己动手改一下插件源码, 比如为了加载jquery.validate插件:

(function( factory ) {
    if ( typeof define === "function" && define.amd ) {
        define( ["jquery"], factory );
    } 
    //-------我自己加的,为了兼容CMD-------
    else if(typeof define === "function" && define.cmd){
        define(function(){
            return function(jq){
                factory(jq);
            };
        });
    }
    //------我自己加的结束--------
    else {
        factory( jQuery );
    }
}(function( $ ) {
       $.extend(...)
       .................
})

用的时候还要这样用:
var $ = require('jquery')
require('validate')($);

我想说的是快点国际化,让老外兼容CMD

@fanxiaolong

大神,你的
define(function(){
return function(jq){
factory(jq);
};
});
我真的看不懂!

@msdlisper

我定义了一模块,这个模块内容是一个闭包,require这个模块就能返回这个闭包,这个闭包接收一个参数,就是外界的jQuery,然后给jQery增加扩展功能,执行完毕. 但个人觉得这不是一个好的解决方案,你们说呢

@fanxiaolong

@x4storm

CDN是个问题。在做国际站时,肯定要根据国内外用户配置不同的CDN。

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Something went wrong with that request. Please try again.