presentation on japanese doc sprint

Apache CloudStackJapanese Doc SprintJapanCloudStackUserGroup

Go Chiba @go_chiba

Go Chiba– Japanse system integrator and supporting

cloud technology in Japan

– Apache CloudStack Japanese TranslatorTranslating ACS docs on private.And become a one of the ACS committer.

– Contactmailto: go.chiba@gmail.comTwitter: @go_chiba

Introduction

Apache CloudStack have below projects for translating– Document tranlating(Apache CloudStack Docs)– GUI translating(Apache CloudStack UI)– Runbook(Quick Install Guide) translating

(Apache CloudStack Runbook)

Target

Translatin w/ Transifsx(https://www.transifex.com)

Displaysections

Sourcedocument

Translateddocument

Recommendeddocument

Transifex

Check your translating with Publican(I confirmed on CentOS 6.3)

1. Install required tools

2. Cone source code from repository and checkout 4.1

3. Install common contents(e.g. images)

# yum install git rpm-build python-setuptools publican# easy_install transifex-client

# git clone https://git-wip-us.apache.org/repos/asf/cloudstack.git# git checkout 4.1

# cd cloudstack/docs/publican-cloudstack# ./gen_rpm.sh# rpm –i ~/rpmbuild/RPMS/noarch/publican-cloudstack-0.6-1.el6.noarch.rpm

Publishing document

Publishing document4. Setting transifex client and pull po files

5. Running publican

Config files: all, adminguide, devguide, installation, niciranvp, release-noteFormat : html, html-single, pdf, epub　　　　　　　　　 　　　

# cd cloudstack/docs# tx init# ./settx.sh# tx pull –l ja_JP

# publican build --config=publican-all.cfg --formats=html,pdf --langs=ja-JP

6.Check doc book# ls tmp/ja-JP/*

Also check PMC member sebastien's presentationhttp://www.slideshare.net/sebastiengoasguen/how-to-translate-apache-cloudstack-docs

Publishing document

Publican's popular error– Duplicate definition

Coment out duplicate definisionfrom cloudstack/docs/en-US

api-throttling.xml:6: validity error : ID api-throttling already defined

Trouble shooting

$ grep '<xi:include href="api-throttling.xml"' *api-calls.xml: <xi:include href="api-throttling.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />sys-reliability-and-ha.xml: <xi:include href="api-throttling.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />

api-throttling.xml:6: validity error : ID api-throttling already defined

Publican's popular error– Reference error

Make sure which file are define ID andadd “<xi:include>” tag

configure-package-repository.xml:28: validity error : IDREF attribute linkend references an unknown ID "sect-source-buildrpm"1

Trouble shooting

$ grep '<section id="sect-source-buildrpm">' *build-rpm.xml:<section id="sect-source-buildrpm">

You can report document bugs on JIRA like a code bugs We wellcome your reviewing even if it's typos :)

– Wrong port number、Miss spell etc…

Document bugs

Future of Docs On 4.2…?― You could find some new docs

Midonet PluginDocs for GSoC and so on...(But above docs are not fixed yet)

We require doc reviewer too!― Integrate fluctuated keywords

VM? Virtual Machine?― Miss copy

Should be use “&PRODUCT;” not “CloudPlatform”― Checking URL