ドキュメンテーションに参加しよう

#osc12cloud

シトリックス・システムズ・ジャパン（株） マーケティング本部 北瀬公彦 @kkitase

CloudStack Collaboration Conference in ラスベガス

• 世界中のCloudStackコミュニティが

一同に集まる国際カンファレンス

• 11/30 – 12/2 までの間、

ラスベガスのヴェネチアンホテルにて開催

• 50以上のセッション ᵒ アーキテクチャ、プロセス、ドキュメンテー

ション、エコシステム、構築系等

ᵒ ハッシュタグ #ccc12

ᵒ 録画は後程アップロードされる予定

ᵒ 全てslideshareにて資料は公開

参考: http://www.aarondelp.com/2012/12/links-to-

everything-cloudstack.html

Apache CloudStack Doc ウェブサイト http://incubator.apache.org/cloudstack/docs/en-US/index.html

Pre-Apache CloudStack Doc ウェブサイト http://docs.cloudstack.org/

CloudStack ドキュメンテーションの歴史

• 2012年4月にCloudStackをApache Software Foundationに、Citrixが寄贈

• Citrix テクパブチーム、既存のドキュメントを寄贈

• 2012年12月現在、CloudStackはASFのインキュベーションプロジェクト

• CloudStackプロジェクトには、様々なドキュメントが既に存在 ᵒ インストールガイド、簡易インストールガイド、管理者ガイド等 ᵒ Word、PDFで生成されている

しかし、OSSのプロジェクトでは、

………… 翻訳しにくい ………… 管理にしくい

Word/PDF Docbook XMLへ変換中

• Docbook XML採用

• Wordから、Docbook XMLへ変換 – マニュアルで変換してます。。。

• 色んなツールもあったけど、結局カットアンドペーストでやってます。。。 – ooo2sdbk, aka Bellot's Convertisseur: Seems to require a lot of customization; and is in French

– pcwTextExportr: Tried, didn’t work

– OpenOffice "save as Docbook XML" feature, requires you to download XSLT & find instructions for XML filter: Download links = broken

– YAWC: “no longer provide support” = likely converts to an outdated Docbook format

– Hire a format conversion service

– Automate using OOo SDK

• マニュアルも悪くない – ドキュメンテーションのレビューもできる、デザインを改善したり、不要なものを落としたり。。。

Docbook cwiki.apache.org/confluence/display/CLOUDSTACK/Documentation+Team

Doc Git Repo git-wip-us.apache.org/repos/asf/incubator-cloudstack.git

/docs

Publican fedorahosted.org/publican/

• FedoraのプロジェクトでRed Hat社等でマニュアルを生成する際に使われている – PDFやHTMLフォーマットへ出力

• 翻訳用にPOファイルを生成

• ユーザーガイド

jfearn.fedorapeople.org/en-US/Publican/2.7/html/Users_Guide/index.html

翻訳しよう！Transifex https://www.transifex.com

projects/p/ACS_DOCS/

最初に言語を作成する場合、 リソースタブ いずれかのリソース 新しい翻訳を追加

でリソースを作成する 言語は、Japanese (japan) ja-JP を指定する

ドキュメントバグをレポートしよう！ Jira cwiki.apache.org/confluence/display/CLOUDSTACK/How+to+File+a+Documenta

tion+Bug

注意: Component/s: Doc

ドキュメントバグを修正しよう！Review Board https://reviews.apache.org/groups/cloudstack 余力があれば、ドキュメントの

修正にもチャレンジしよう。 ドキュメントを修正すれば、 Review Boardにパッチをのせ、コミッターがその修正をコミットするのを待とう。

継続的インテグレーションツール Jenkins http://jenkins.cloudstack.org

コミット等があれば、 自動的にビルドが行われ PDFが生成される

リファレンス

• ウェブ: – 本家: http://cloudstack.org

– 日本語: http://cloudstack.jp

• メーリングリスト: – cloudstack-dev@incubator.apache.org

– cloudstack-users@incubator.apache.org

– 日本語: users@cloudstack.jp

• IRC: – #cloudstack on irc.freenode.net

• Facebook: – www.facebook.com/groups/cloudstack/

– www.facebook.com/cloudstackjapan

• ドキュメントバグのレポートの方法や、貢献について – cwiki.apache.org/confluence/display/CLOUDSTACK/How+to+File+a+Documentation+Bug

– cwiki.apache.org/confluence/display/CLOUDSTACK/CloudStack+Documentation+Contributors+Overview

– cwiki.apache.org/confluence/display/CLOUDSTACK/Documentation+Team

ご清聴ありがとうございました。 ドキュメンテーションの参加を

お待ちしております!!