Homeland 我觉得应该把 wiki 迁移到 Github wiki

Rei · 2014年03月12日 · 最后由 Rei 回复于 2014年06月30日 · 10486 次阅读

现在 Ruby China 的 wiki 功能并不完整,例如 [[]] wiki 链接,只是一个带版本的文章页,并且限制了编辑,导致很多内容过时,但是新手却以为这是社区维护的内容而跟着做,结果引出一些问题。

我觉得可以把 wiki 迁移到 Github 上,开一个专门的 repo,使用它的 wiki 功能,自己开发维护 wiki 并不划算。迁移方法就是把文章复制粘贴过去,然后修改顶栏链接。

为了长期维护 wiki 内容,还需要一个 wiki team。考虑到 you can you up 原则,我做第一个成员,然后在活跃贡献者中吸纳更多成员。不过我的内容口味会比较严格,现有的一些口语化调侃类内容会去掉。对于 wiki,中立客观化内容会更持久。

对于内容贡献者我想说,基础类教程(工具搭建、使用等)一起写 wiki 的作用要大于在自己博客写教程,所以我提议想写基础教程的人能优先考虑贡献到 wiki。

如果我的提议能获得不少人支持,那么我就去 ruby-china 创建新 repo,开始整理条目,欢迎各位提出意见建议。

:metal:

积极报名,踊跃参与!

支持 :plus1:

支持 :thumbsup:

支持 :plus1:

而且建议 wiki 不只是放文章,而更多的是对词条的解释,更符合 wiki 的本意

#7 楼 @swordray 赞同,我计划有两类内容,一类是词条,一类是实践。

最佳实践👍

听听 @huacnlee 意见

好,这样会有些实用的教程,还能及时更新

可以呀! 这样有 Pull Request 以后就可以放心的让所有人参与修改了

这边的 Wiki 或许可以通过 git 拉取 Github Repo 的内容来生成,以便给那些还没学会翻墙的人看

#17 楼 @huacnlee PR 吗……我原先打算是用 wiki 功能来着。wiki 功能好处是对 wiki 格式比较全(适合词条),任何人都可以直接改,缺点是没有 PR 过程,被恶意修改就只有关闭不能让任何人修改。

用 Github Page 优点是可以 PR,可以定制样式,好像没啥缺点。(用 Page 还需要叫 wiki 吗?)

大家给点建议。

#18 楼 @Rei Wiki 好像都是有 PR 的

我现在是倾向 wiki 的,善意推定。

https://github.com/ruby-china/wiki/wiki

建了目录,希望有人认领具体页面的维护。

支持!

Python 社區有類似的項目,The Hitchhiker’s Guide to Python!,可以借鑑學習。

#22 楼 @Rei

github 的 wiki 本身也是一个 git 仓库,所以可以这样子:

  • 关闭 wiki 的修改权限
  • 将文件放在 github 里,使用 PR 机制来贡献内容
  • 当 master 分支更新时,将更新 push 到 wiki 仓库

#25 楼 @c605 这个主意不错

#26 楼 @Rei wiki 的 repo 地址就是 repo.wiki.git

先用 wiki 做起来吧,内容最重要,以后要换形式也不难。

我刚刚写了一份 https://github.com/ruby-china/wiki/wiki/RVM ,我还可以贡献 Capistrano,Vagrant,Vim,Ubuntu 12.04 上部署 Ruby on Rails 的资料,有人分担就最好了。

rbenv,Windows 上编译 Native Gem,Emacs,Sublime Text,RubyMine 是我不了解的,需要认领。

原来的 wiki 内容质量参差不齐,不想原样导入,新写的 wiki 希望重新整理语句。

:thumbsup: :thumbsup: 👍 👍

Ubuntu 12.04 上部署 Ruby on Rails https://github.com/ruby-china/wiki/wiki/Ubuntu-12.04-%E4%B8%8A%E9%83%A8%E7%BD%B2-Ruby-on-Rails

我没测试过,发现错误的帮忙修改。

👍 内容有什么限定么?比如在 Cubieboard 上布署 Gitlab 之类的可以上 wiki 不?

@Rei 我想按多级标题列一下 Ruby 应用,便于理清思路,例如分服务器端和浏览器端,浏览器端又分 HTML、CSS、JavaScript 这样,不知道可不可以

#34 楼 @kfihihc 属于实践类文章,觉得有人需要就写吧,以后要维护哦。

#35 楼 @swordray 我觉得这是不是 https://www.ruby-toolbox.com/ 做了?

#36 楼 @Rei 我肯定不会这样简单的大量罗列所有 Ruby 库,而是精选 Ruby 开发者几乎必用的功能,例如 Assets、Slim、Scss,并对每一项写 Wiki 介绍

#37 楼 @swordray 那写吧。

PS:更新了简短的规则

  • 写别人需要的内容
  • 考虑别人如何理解
  • 语言简练、中立、客观
  • 引用内容标明出处

#38 楼 @Rei 那我试试了,如果不满意的可以随时修改

是不是在 ruby-china wiki 页面 提醒下 可以到 rept.wiki 页查看最新 wiki 并贡献内容

@Rei 你的想法太好。我把我们公司的 wiki 都搬过来了,公司的删掉了,另外写了我最喜欢的 Rails、Slim、Sass。

#41 楼 @swordray https://github.com/ruby-china/wiki/wiki/Mac-OS-X-%E4%B8%8A%E5%AE%89%E8%A3%85-Ruby 这一页看不明白啊。

有几个问题:

  1. 是不是一定要安装(系统预装了没有)
  2. 页面列出的几个库是不是都要安装(不装数据库行不行,这一页是讲 Ruby)
  3. 如果有多种安装方法,那么之间的区别是什么

现在的内容没考虑到别人怎么理解。

参考这页吧 https://github.com/ruby-china/wiki/wiki/RVM

#42 楼 @Rei

1、在 OS X 上 XCode、GCC、MacPorts 都必须下载安装,没有预装 2、除了数据库外其它都是必装的,不然没有编译环境,装不了 RVM。数据库我删了吧 3、XCode、GCC、MacPorts 都是必装的。RVM 和 rbenv 的区别比较应该算另外一个话题了,这个页面按我理解应该只说安装方法

#42 楼 @Rei 另外使用了更准确的名词,前一项是 预编译库,后一项是 Ruby 管理器

#43 楼 @swordray

1. Mac 预装 Ruby 了没? 3. 为什么需要 RVM,rbenv,现在列出来的层次就是每个都要安装一遍。

https://github.com/ruby-china/wiki/wiki/%E5%AE%89%E8%A3%85-Rails

这一页有类似的问题,

  1. 为什么是 gem 'rails', github: 'rails/rails' 而不是 gem 'rails'
  2. 为什么需要源码
  3. 初始化是什么时候做,是必须的吗?没有上下文
  4. 服务那里更笼统了。

这两个页面给新人看绝对看不明白。我希望页面内容要考虑不了解 Ruby 的人如何理解(他/她可能有其他编程经验)。

@swordray 首页索引要整体考虑,这两个部分重复了

Home 目录由我管理吧。

#45 楼 @Rei

  1. 预装了 Ruby 了,但版本是 1.8,装 RVM 是必须的
  2. 已增加说明

https://github.com/ruby-china/wiki/wiki/%E5%AE%89%E8%A3%85-Rails

  1. 目前以我了解的主流用法是 github: 'rails/rails' ,可以提出来讨论。wiki 本来大家不断修改完善,不一定要一口气写好
  2. 我觉得 wiki 不只是给新手看的,而是使所有人受益
  3. 这不是几百页的 Rails 教程,如果每一点都要解释的非常清楚的话篇幅会非常长
  4. 同 1、2、3 的原因

我想我们对 wiki 的看法还没有完全一致。从我对 wikipedia 的了解来看,wiki 主要是解释一下关键性的概念,实际上很多词条拿出来都可以写一本书了,都放在 wiki 里是有困难的。

我建议把词条和教程这两个不同需求分开,就像 wikipedia 和 wikimedia 的其它项目一样。

#46 楼 @Rei 注释里写了这部分待整理,还是跟上面说的一样,wiki 是大家共同完善的,不一定要一个人一口气写好

#48 楼 @swordray 没错,我们理念不一致。我觉得你写的内容就是随手笔记,完全没考虑别人怎么看。

如果第一个写的人只是随手填些内容,那么很难有人接手维护。现在 wiki 添加了一大堆页面,质量都不过关,如果我不是这次的发起者,那么我不如关掉页面写自己的博客。

易懂不一定需要长篇,举个修改例子:

不是

## [[Ruby]] 管理器

可以选择其一安装。

### [[RVM]]


\curl -L https://get.rvm.io | bash -s head --ruby
rvm install 2

### [[rbenv]]

TODO

而是

## 版本管理

如果需要安装多个版本的 Ruby,可以使用 [[RVM]] 或 [[rbenv]] 进行版本管理。

让读者知道用这个工具的目的是什么,并且利用已有的内容不要重复。

如果第一个写的人只是随手填些内容,那么很难有人接手维护

wikipedia 同样有这种现象,但是后面会不断有感兴趣的人去修改。我创建的页面也非常欢迎你继续改进。如果一开始就定为一个人写一个页面,并且一开始就要写好才能提交,以后就更难培养出 wiki 协作的氛围来了,最终有可能变成一个集体博客。

举个例子,刚才我在 Stack Overflow 问个问题,12 分钟后就有 3 个人把我的话从头到尾改了一遍

#51 楼 @swordray 集体协作不是留下烂摊子的借口。一个新的 wiki 不会有那么多优质内容提供者参与。

我考虑转 pull request 方式了,这样下去会陷入编辑泥潭。

#52 楼 @Rei 可以试试 pull request 的方式,我只是提供一种建议

@Rei 能通过我的 gmail 加好友申请码?

想请教你一个问题?

#54 楼 @putty 有问题可以发帖讨论吗?

好的,我现在在 grape 里调用 update_without_password params params 里没有 avatar 会导致原来的 avatar 变成无效的,按道理来说如果没有 avatar 就不要去更新 user 的 avatar。实际测试的结果是会去更新 avatar

#57 楼 @putty 我没用过 grape。

(⊙v⊙) 嗯,折腾了 1 个多小时。

@Rei 在 controller 里,你知道怎么让 update_attributes 时不更新 avatar 字段的方法吗?

#60 楼 @putty ActiveRecord + carrierwave 默认就不会更新 avatar 空字段。

#60 楼 @putty 你传给 update_attributes 的参数一定带了 avatar 字段

@Rei 我没想到我们的理念相差比较大,事先没沟通好就开始动笔,是我的责任。希望你按你的理念写出好的 wiki 来,我就把我写的部分撤了,以免影响到你的思路。

再次说声非常抱歉,以后会尽量提前沟通好。

@swordray current_user.update_attributes(params[:user])

ashie::Mash bio="fdccvbhh" email_public="true" location="\xE6\xB7\xB1\xE5\x9C\xB3" name="\xE7\x9C\x8B\xE7\x9C\x8B" tagline="" website="">

#64 楼 @swordray 没有金刚钻,不揽瓷器活是我的错。我的想法更像是 https://library.linode.com ,不应该用 wiki 旗号。

#65 楼 @putty 我觉得你可以开一个贴。

@Rei 好的,我退出这个贴

#68 楼 @Rei 果然 https://library.linode.com/ 跟我的思路完全不同,我看到 wiki 这两个字就奔 wikipedia 去了 😓

@Rei 是打算用 jekyll 建一个 wiki 了?

#72 楼 @lepture 是的,不过不叫做 wiki 了。

#73 楼 @Rei 我觉得你想做的是 Knowledge Base,不是 Wiki。如果这样的话,建议

  • 还是用一个 GitHub Repos 来做
  • Contributors 通过 Pull Request 来实践会比较好
  • 内容质量的控制通过多人 Review 以及 Approval 来达成

这种内容质量要求高于产出速度

@Rei 我更新了推荐书籍《Agile Web Development with Rails》相关的说明,麻烦您检查一下:https://github.com/ruby-china/ruby-china/wiki/%E4%B9%A6%E7%B1%8D%E6%8E%A8%E8%8D%90

#77 楼 @diguage 我改了一下,去掉后面的主观语句。wiki 写结论就行了,讨论在别的地方进行。

hellorails Wiki 能开放编辑权限,保留审核权限吗 提及了此话题。 10月19日 19:44
需要 登录 后方可回复, 如果你还没有账号请 注册新账号