/var/log/messages

debugging with sixth sense

すごい広島てきドキュメントの作り方

纏めて共有してみる方向。

ドキュメントをローカルで確認できる環境の用意

1
$ git clone git@github.com:OkinawaDevOps/okinawadevops.github.com.git
  • rbenv 使える状態 (かつ bundler が使える状態) になってる前提でディレクトリ移動して以下
1
2
$ cd okinawadevops.github.com
$ bundle install
  • ruby-dev パケジの導入が必要みたいでした? 違うな
  • どうも bundle update nio4r が必要みたいでした
  • rake タスクの確認は bundle exec rake -T なのですが preview できぬ
  • bundle update jekyll してみました
  • 見れました、これでドキュメントを云々する用意は完了

ドキュメントの作成

手順はドキュメントに記載されているので割愛かな。基本的には

  • issue 作成
  • branch 作る
  • 自分の作業を記録する markdown を作成
  • pull request を作成
  • 二人にレビュしてもらって LGTM なコメントをもらう
  • https://lgtm.in/
  • 二人目のレビュアが merge

というルール。

Comments