Fwd: [openpne-dev:714] 「OpenPNE OpenSocailPlatform ユーザーズガイド」をつくっています
Kimura Youichi
-------- Original Message --------
Subject: [openpne-dev:714] 「OpenPNE OpenSocailPlatform ユーザーズガイ
ド」をつくっています
Date: Mon, 13 Jun 2011 19:29:13 +0900
From: 國忠亮介 <kuni...@tejimaya.com>
Reply-To: openp...@ml.pne.jp
To: openp...@ml.pne.jp
@kawahara
cc ukimura
kunitadaです。
下記2点確認ください。
■1■「OpenPNE OpenSocailPlatform ユーザーズガイド」について
OpenPNEのOpenSocialのドキュメント(
http://www.openpne.jp/developer/opensocial/ja/ )をより充実させるために、
ukimuraさんと「OpenPNE OpenSocailPlatform ユーザーズガイド」として構成の
変更&内容の加筆を行っています。
ドキュメントのレポジトリは、
https://github.com/upsilon/OpenPNE3-doc/commits/opensocial/
あたりです。
確認環境は、
http://opensocial-doc.myzw2.pne.jp/
で、反映しながら進めています。
6月末までには大体形になると思います。
■2■方向性の確認
現時点でkawaharaさんが想定するドキュメント像と食い違うところがあったら教
えてください。
大きく方向性が違わないなら、
http://www.openpne.jp/developer/opensocial/ja/
を置き換える感じで考えたいです。
Kawahara, Shogo
こんばんは。川原です。
素晴らしい試みだと思います。
■ 疑問点・改善点
・opOpenSocialPlugin 1.2.x 向けドキュメント改善と考えて問題ないですか?
・著者は追記、コピーライトは書き換えたほうがいいと思います。
(コピーライトは OpenPNE Project 表記?)
・SNS設置者向けドキュメント・アプリ作成者向けドキュメントは分離したほうがいいかもしれません。
(1.4.x 向きドキュメントから考えたほうがいいかもしれません。)
・リポジトリも分離したほうが作業したほうがいいかもしれません。
(作業者の意見を聞きつつ意思決定したいです。
上と同じく 1.4.x 向きドキュメントからとしてもいいかもしれません。)
2011年6月13日19:48 Kimura Youichi <kim.u...@bucyou.net>:
--
----------------------------------------------------------
Shogo Kawahara <kawa...@bucyou.net>
川原 翔吾
Kimura Youichi
> ・opOpenSocialPlugin 1.2.x 向けドキュメント改善と考えて問題ないですか?
1.2.x 向けドキュメントを基に加筆していますが、動作確認は master で行って
いたので 1.4.x に向けたドキュメントとして扱う方が良いかもしれません。
> ・著者は追記、コピーライトは書き換えたほうがいいと思います。
> (コピーライトは OpenPNE Project 表記?)
コピーライトは後回しにしたままでした :)
「OpenPNE Project」表記は賛成です。
> ・SNS設置者向けドキュメント・アプリ作成者向けドキュメントは分離したほうがいいかもしれません。
> (1.4.x 向きドキュメントから考えたほうがいいかもしれません。)
「SNS設置者向けドキュメント」は分量があまり多くなかったため分割は考えて
いませんでした。分割はドキュメントの内容が充実してからの検討で良いと思い
ます。
> ・リポジトリも分離したほうが作業したほうがいいかもしれません。
> (作業者の意見を聞きつつ意思決定したいです。
> 上と同じく 1.4.x 向きドキュメントからとしてもいいかもしれません。)
1.2.x 向けドキュメントの加筆から始まったため同じリポジトリで更新し続けて
いました。現時点でも加筆量が多くなっていることやリポジトリを分離すれば
バージョンごとにブランチを設けられることからも、リポジトリの分離には賛成
です。
# ところで redmine.openpne.jp で1プロジェクトに複数のリポジトリを登録す
ることは出来るのでしょうか？
--
Kimura Youichi <kim.u...@bucyou.net>
http://upsilo.net/~upsilon/
Kawahara, Shogo
1.4 向けドキュメントとして考えましょう。
そして、コピーライトの変更はお願いします。
設置者向け・アプリ開発者向けドキュメントの分離に関しては
opOpenSocialPlugin 1.4.x リリースまでに意思決定したいと思います。
(設置者向けは、分量が多くないので opOpenSocialPlugin に rst で
同梱しても良いかもしれません。)
リポジトリ分離については幾つかの利点があるので行いたいと考えています。
・単独でバージョン管理ができる。
・現状ディレクトリごとにバージョンを管理している状態だが、
本来はブランチやタグで管理することができる。
残念なことに、 Redmine 上では、1つのプロジェクトで 2つ以上の
レポジトリをもつことができないので、
・別プロジェクトとして管理する (opOpenSocialPlugin のサブプロジェクトを作成することは可能かもしれない)
・適切な Issue と Revision の紐付けはできないが、現行のプロジェクトで特定のカテゴリや
ロードマップ下で管理する。
個人的には、 Issue と Revision を紐付けたいので、前者のほうがいいと思います。
ここらへんがまとまれば、ドキュメント専用共用レポジトリをつくろうと思います。
2011年6月18日0:32 Kimura Youichi <kim.u...@bucyou.net>:
--
Kimura Youichi
実際にリポジトリ分割を行うとどうなるのか試してみました。
https://github.com/upsilon/opOpenSocialPlugin-doc
上記リポジトリの通り、OpenPNE3-doc から分離した上でバージョンごとにブラ
ンチを分けました。
また、各ブランチにおけるドキュメントの内容は↓のURLから閲覧できます。
1.4.x 向け: http://opensocial-doc-septest.myzw2.pne.jp/1.4/
1.2.x 向け: http://opensocial-doc-septest.myzw2.pne.jp/1.2/
1.0.x 向け: http://opensocial-doc-septest.myzw2.pne.jp/1.0/
Kunitada Ryosuke
ukimuraさんが書いてくれてるとおり、
> 1.4.x 向け: http://opensocial-doc-septest.myzw2.pne.jp/1.4/
> 1.2.x 向け: http://opensocial-doc-septest.myzw2.pne.jp/1.2/
> 1.0.x 向け: http://opensocial-doc-septest.myzw2.pne.jp/1.0/
が良い感じに仕上がってきたので、
http://www.openpne.jp/developer/opensocial/ja/1.4/
http://www.openpne.jp/developer/opensocial/ja/1.2/
http://www.openpne.jp/developer/opensocial/ja/1.0/
みたいな感じで反映していく方向で動きたいです。
kunitadaが、
http://www.openpne.jp/developer/opensocial/
へのUP権限を失念してしまったのですが、
kawaharaさんは持ってるのでしたっけ？
持ってるならぜひukimura氏とkunitadaに共有していただきたいです。
2011年6月25日10:09 Kimura Youichi <kim.u...@bucyou.net>:
Kawahara, Shogo
kunitada さん
私は www.openpne.jp の操作権限はありません。
おそらく、 ogawa さんが持っています。
小川倫平
サーバの操作権限を特定の人に渡してもよいのですが、
GitHub の特定のブランチから cron で自動ビルドとか作っちゃったほうがよかったりしますかね？
（たぶんこの方法でも難しくないのですぐできる）
サーバのログインアカウントは今後誰にでも発行するわけにはいかないと思うので、
自動ビルドの方が将来的にはいいかなと思ってます。
2011年7月1日7:12 Kawahara, Shogo <kawa...@bucyou.net>:
--
小川倫平 <og...@tejimaya.com>
株式会社手嶋屋
http://tejimaya.com
東京都新宿区新宿1-6-8 新宿鈴木ビルA館7F
Tel: 03-6380-4575
Kimura Youichi
upsilon/opOpenSocialPlugin-doc へのドキュメントの分離がいい感じにできて
いるので、このツリーを各バージョンのドキュメントに使いたいと考えています。
そこで、現在の upsilon/opOpenSocialPlugin-doc のリポジトリを GitHub 上の
(新規または既存の) Organization に移動しようと思っているのですがどうで
しょうか？
理由としては下記の通りです。
* 現在のまま (upsilon/opOpenSocialPlugin-doc) だと僕一人がコラボレー
ターの設定権限を持っている状態になってしまう。様々な理由で upsilon が音
信不通になると為す術が無くなる。
* Organizationではコラボレーター権よりも若干権限のバリエーションが増える
* freeプランなので特に費用は掛からない
移行するとした場合には、Organizationを新規に作るか既存の物を使うかについ
ても意見が欲しいです。
Kunitada Ryosuke
@all
http://www.openpne.jp/developer/opensocial/ja/
のドキュメントを更新してみました。
詳細は↓のブログなどで。
http://d.hatena.ne.jp/openpne/20110705/1309850564
@ogawa
> GitHub の特定のブランチから cron で自動ビルドとか作っちゃったほうがよかったりしますかね？
いいですね、賛成です。
さっきwww.openpne.jpのサーバでSphinxのドキュメントをmakeしようとしたんだけど、
↓とか出てしまい、どこまでこのサーバいじっていいかわからないなかったので、scpで置きました。(make成功した環境ではSphinx v1.0.7でした)
========================================================
make html
sphinx-build -b html -d .build/doctrees . .build/html
Making output directory...
Running Sphinx v0.6.5
Theme error:
no theme named 'haiku' found (missing theme.conf?)
make: *** [html] Error 1
========================================================
2011年7月1日13:57 小川倫平 <og...@tejimaya.com>:
小川倫平
haiku は 1.0 で追加されてるみたいですね。
http://sphinx.pocoo.org/changes.html#release-1-0-jul-23-2010
www.openpne.jp 上にある他のドキュメントのビルドにも影響ないかどうか確認して、
問題なければバージョン上げておきます。
2011年7月5日16:46 Kunitada Ryosuke <kuni...@gmail.com>:
Kawahara, Shogo
Organization に移す提案は、 kawahara/opOpenSocialPlugin
が、opOpenSocialPlugin ソースの共用レポジトリになっている件も
含めて検討したい項目です。
この件を、この返事で話すと、ドキュメントの話題からそれてしまうので、
別の話題とします。
https://groups.google.com/group/op-opensocialplugin-dev/browse_thread/thread/98ea4b2de2915747
2011年7月5日15:48 Kimura Youichi <kim.u...@bucyou.net>:
--