- OpenStack-I18n - lists.openstack.org

Code block in RST and translation
by Akihiro Motoki 27 Nov '15

27 Nov '15

Hi, According to [1], we use two types of code blocks in RST documentations. The one is to end a line with "::" [2] and the other is to use 'code-block'. During translation, I noticed the first style can be a wrong formatting in translated documents (it will be considered as "block quote" as far as I tested). It is not easy that translators understand "::" at end of line has a special meaning. To keep the format, translators MUST keep "::" at the end of line, but ":" is rarely used in some languages and I think they will forget "::" easily. In addition, it is hard to detect this kind of things during translation reviews. Note that other RST conventions are easier to be recognized as special because they are very different from usual strings. On the other hand, ending a line with "::" is a standard ReST convention and it is widely used in writing documents in ReST format. My idea at now is to use "code-block" directive as possible as we can, but I am not sure it is the right direction as "::" is widely used. Thought? Thanks, Akihiro [1] http://docs.openstack.org/contributor-guide/rst-conv/source-code.html [2] http://docs.openstack.org/contributor-guide/rst-conv/source-code.html#stand… [3] http://docs.openstack.org/contributor-guide/index.html#search-in-this-guide

4 6

Arch Design Guide RST conversion finished
by KATO Tomoyuki 27 Nov '15

27 Nov '15

Hi team, Docs team finished Arch Design Guide RST conversion. At now, new RST translation resource is uploaded to Zanata. openstack-manuals / arch-design (same name) Best Regards, KATO Tomoyuki

1 0

release notes translation
by KATO Tomoyuki 26 Nov '15

26 Nov '15

Hi team, Maybe, as you know, we have the new release notes tool "reno". As far as I know, reno doesn't have translation feature. I'm not sure whether it is planned or not. So, we need to contact and maybe work with reno team. Anyone, interested in taking a lead? Here is a rough blueprint: https://blueprints.launchpad.net/openstack-i18n/+spec/release-notes-transla… Best Regards, KATO Tomoyuki

2 2

DocImpact Changes
by Lana Brindley 25 Nov '15

25 Nov '15

-----BEGIN PGP SIGNED MESSAGE----- Hash: SHA256 Hi everyone, The DocImpact flag was implemented back in Havana to make it easier for developers to notify the documentation team when a patch might cause a change in the docs. This has had an overwhelming response, resulting in a huge amount of technical debt for the docs team, so we've been working on a plan to change how DocImpact works. This way, instead of just creating a lot of noise, it will hopefully go back to being a useful tool. This is written in more detail in our spec[1], but this email attempts to hit the highlights for you. TL;DR: In the future, you will need to add a description whenever you add a DocImpact flag in your commit message. Right now, if you create a patch and include 'DocImpact' in the commit message, Infra raises a bug in either the openstack-manuals queue, or (for some projects) your own project queue. DocImpact is capable of handling a description field, but this is rarely used. Instead, docs writers are having to dig through your patch to determine what (if any) change is required. What we are now implementing has two main facets: * The DocImpact flag can only be used if it includes a description. A Jenkins job will test for this, and if you include DocImpact without a description, the job will fail. The description can be a short note about what needs changing in the docs, a link to a gist or etherpad with more information, or a note about the location of incorrect docs. There are specific examples in the spec[2]. * Only Nova, Swift, Glance, Keystone, and Cinder will have DocImpact bugs created in the openstack-manuals queue. All other projects will have DocImpact bugs raised in their own queue. This is handled in [3] and [4]. This will hopefully reduce the volume of DocImpact bugs being created in the openstack-manuals queue, and also improve the quality of the bugs that are created. I know there is a fair amount of confusion over DocImpact already, so I'm more than happy to field questions on this. Thanks, Lana 1: http://specs.openstack.org/openstack/docs-specs/specs/mitaka/review-docimpa… 2: http://specs.openstack.org/openstack/docs-specs/specs/mitaka/review-docimpa… 3: https://review.openstack.org/#/c/248515/ 4: https://review.openstack.org/#/c/248549/ - -- Lana Brindley Technical Writer Rackspace Cloud Builders Australia http://lanabrindley.com -----BEGIN PGP SIGNATURE----- Version: GnuPG v2 Comment: Using GnuPG with Thunderbird - http://www.enigmail.net/ iQEcBAEBCAAGBQJWU5Q0AAoJELppzVb4+KUyYz4H/j+iAG5x2iRiNbJMBgxm5Qb5 tvxzlOePHZa6VQKj1gYrp8wnBFab0CsNDt/U03D8H9D6No2hqz5qvFgOuMDXIOkS DXG+2RDD8xKMRS42t70mNtJu2oPl+9BWIre+Qyvjd7heicGd+lN/mqAvmwVV3tKB fwJl3iLrlSpwwsyunzR3LxGxzVfHUroRdFv11iQGQZNJYbS9DfOLsz66e5JBTZPh ZoCK8VAlEionaL8ExppoMPQOwpU0oYMWSjM2HGxlc/RDrNEz7HWfXl36nxqfw/mO q8Op0p5cn5UW4fYv/9Ufbw6k0JRgwODCwzSEzJ73gmOJpBrcTEdZKocnGDSdtYA= =CCIn -----END PGP SIGNATURE-----

3 3

New guides published
by Andreas Jaeger 25 Nov '15

25 Nov '15

FYI, Japanese networking guide and Chinese (zh_CN) Install Guides have been added as drafts: http://docs.openstack.org/draft/draft-index.html Andreas -- Andreas Jaeger aj(a){suse.com,opensuse.org} Twitter: jaegerandi SUSE LINUX GmbH, Maxfeldstr. 5, 90409 Nürnberg, Germany GF: Felix Imendörffer, Jane Smithard, Graham Norton, HRB 21284 (AG Nürnberg) GPG fingerprint = 93A3 365E CE47 B889 DF7F FED1 389A 563C C272 A126

1 0

Virtual Machine Image Guide RST conversion finished
by KATO Tomoyuki 25 Nov '15

25 Nov '15

Hi team, Sorry for late announce. Virtual Machine Image Guide RST conversion has finished. You can look at new translation resource at Zanata: openstack-manuals/image-guide (same name) Unfortunatelly, we has droped the translations with XML markup, which is replaced with RST markup. However, we can easily translate them from Zanata translation memory. Tips: The strings ":guilabel:`xxxx`" is needed to keep this structure. :guilabel:`[yourlanguage]` This is a kind of RST markup. Best Regards, KATO Tomoyuki

1 0

translate.openstack.org upgraded to Zanata 3.7.3
by Elizabeth K. Joseph 20 Nov '15

20 Nov '15

Hi everyone, Thanks to work by Steve Kowalik and testing the upgrades on our translate-dev server, we have landed the upgrade of the production Zanata server from 3.7.1 to 3.7.3. This isn't a major upgrade, but if you're curious as to what has changed, release notes are as follows for the two versions we've upgraded through: 3.7.2: http://docs.zanata.org/en/latest/release-notes/#372 3.7.3: http://docs.zanata.org/en/latest/release-notes/#373 We'd like to involve Daisy and others as we do subsequent upgrades, particularly when we reach the major releases. Steve has written a script to query the API prior to upgrade and after the upgrade on the dev server so that we can be more confident that all of our scripts will continue to work in production, and I'll ask for volunteers from this team to look at translate-dev to confirm that the UI acts the way we expect it to after upgrading translate-dev and before upgrading the production translate server. I've logged in and walked through the UI post upgrade today, but please let us know if you have any trouble. -- Elizabeth Krumbach Joseph || Lyz || pleia2

3 3

What's Up Doc, 20 Nov 2015
by Lana Brindley 20 Nov '15

20 Nov '15

-----BEGIN PGP SIGNED MESSAGE----- Hash: SHA256 Hi everyone, This week I've been working on catching up with some reviews and bug triage, I've been speaking to O'Reilly about the future of the Ops Guide, and also been working on a range of other things including docs-specs core team review, and the addition of Zaqar docs into the user guides. Just a quick heads up that there won't be a docs newsletter next week, though, as I'm taking a couple of days off (my Mum is coming to visit!), so I'll see you again around 4 December. For those of you in the United States, I hope you all have a lovely Thanksgiving :) == Progress towards Mitaka == 138 days to go! 119 bugs closed so far for this release. RST Conversions * Arch Guide ** https://blueprints.launchpad.net/openstack-manuals/+spec/archguide-mitaka-r… ** Contact the Ops Guide Speciality team: https://wiki.openstack.org/wiki/Documentation/OpsGuide * Ops Guide ** https://blueprints.launchpad.net/openstack-manuals/+spec/ops-guide-rst ** Determining whether or not we want to do an updated version for O'Reilly in L * Config Ref ** Contact the Config Ref Speciality team: https://wiki.openstack.org/wiki/Documentation/ConfigRef * Virtual Machine Image Guide ** https://blueprints.launchpad.net/openstack-manuals/+spec/image-guide-rst and https://review.openstack.org/#/c/244598/ Reorganisations * Arch Guide ** https://blueprints.launchpad.net/openstack-manuals/+spec/archguide-mitaka-r… ** Doc sprint in planning for December. Contact the Ops Guide speciality team for more info or to get involved. ** Contact the Ops Guide Speciality team: https://wiki.openstack.org/wiki/Documentation/OpsGuide * User Guides ** https://blueprints.launchpad.net/openstack-manuals/+spec/user-guides-reorga… ** Contact the User Guide Speciality team: https://wiki.openstack.org/wiki/User_Guides DocImpact * I've added some examples to the spec, and we're pretty much ready to go now: https://blueprints.launchpad.net/openstack-manuals/+spec/review-docimpact Document openstack-doc-tools and reorganise index page * Thanks to Brian and Christian for volunteering to take this on! Horizon UX work * Thanks to the people who offered to help out on this! If you're interested but haven't gotten in touch yet, contact Piet Kruithof of the UX team. == Speciality Teams == '''HA Guide - Bogdan Dobrelya''' Two patches look ready for merge now: https://review.openstack.org/#/c/225418/ and https://review.openstack.org/235893 '''Installation Guide - Christian Berendt''' Business as usual. Nothing special to mention this week. '''Networking Guide - Edgar Magana''' Open Reviews: https://review.openstack.org/#/c/239361/ Merged: https://review.openstack.org/#/c/246671/ Very slow progress, hoping to speed up after the USA holidays. '''Security Guide - Nathaniel Dillon''' No update this week '''User Guides - Joseph Robinson''' After a specification update, there is a need to provide a more comprehensive scope: a list of Core features within scope, and include research on the nova-network/ neutron migration study. Contact from Zaqar, Trove, and Murano Liaisons on Admin guide tasks has been helpful, and given the reorganisation direction. A patch on fernet tokens (FAQ format) merged into the Cloud Admin Guide this week. '''Ops and Arch Guides - Darren Chan''' Arch guide migration is close to completion. We are currently planning to reorganize the guide over a two day virtual sprint in mid December. '''API Docs - Anne Gentle''' Review ready for the Mitaka specification of a vision for app dev docs: https://review.openstack.org/#/c/246660/ '''Config Ref - Gauvain Pocentek''' The tools are ready, the liberty branch is set up, the RST migration is on! Pick your file, run the tools, and let's review. '''Training labs - Pranav Salunke''' Training-labs has Kilo patch merged! We are currently updating the network configuration and trying to get things as per Matt's feedback/request. We plan to start adding Liberty very soon and also KVM port is on the way. '''Training Guides - Matjaz Pancur''' There is interest in translating Upstream training; we are waiting for https://review.openstack.org/#/c/245615/ to merge to enable it on the repo. '''Hyperviser Tuning Guide - Joe Topjian''' On schedule - working on changing bullet-point notes into rough draft sections. == Doc team meeting == We held the US docs meeting this week, you can read the minutes here: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2015-11-18 Next meetings: APAC: Wednesday 25 November, 00:30:00 UTC US: Wednesday 2 December, 14:00 UTC Please go ahead and add any agenda items to the meeting page here: https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting#Agenda_for_next_mee… - -- Keep on doc'ing! Lana - -- Lana Brindley Technical Writer Rackspace Cloud Builders Australia http://lanabrindley.com -----BEGIN PGP SIGNATURE----- Version: GnuPG v2 Comment: Using GnuPG with Thunderbird - http://www.enigmail.net/ iQEcBAEBCAAGBQJWTqEMAAoJELppzVb4+KUyx8AH/0AOs2kfvR8TwvMTO9FSuT2F UkfrQfzqPIPjU0d4prIkFxJJ3k9NlGDS4+h2lgZSsqYSDRfinoYMkzAOFGOBB0I/ P9KYx7dd+IRagmF2bOfIDBhl+qTxD4GrzaKdzpH9kAaizmf1xylk6VCXT2Yh0PRd wPRw7RAXg3XjvJhQIElm0pNoRijikAR1CfafzR+HnZMswXPI1S1NnwQSBJD3yYwK npdfEiICdIkzTcdNMODzN57PXkLBymb++EAW/UsWEnmlyyIGJTZqlJNbd8TAGjHz vpvILlZHsuJ8mavPASStZy0ZZad3svusNf6pbsZEdUcS3ibZKRSb3xpEOh31eC0= =7tXE -----END PGP SIGNATURE-----

1 0

IRC meeting tomorrow
by Ying Chun Guo 18 Nov '15

18 Nov '15

Hello, team We will have IRC meeting tomorrow at 1300 UTC in the IRC channel #openstack-meeting. I'm going to cover following topics tomorrow. If you have more topics, please propose freely. * Status update and issues collection of the work items * Discussion: how to manage I18n related bug reports ? * Open discussions Best regards Ying Chun Guo (Daisy)

1 0

Re: [Openstack-i18n] RFC: draft doc on how to report translation bugs
by Akihiro Motoki 18 Nov '15

18 Nov '15

BTW, The I18n team meeting wiki page says the next meeting is "Thursday, 5th December at 0600 UTC". Is this wrong information? 2015-11-18 11:59 GMT+09:00 Ying Chun Guo <guoyingc(a)cn.ibm.com>: > Thank you for initiating this. > Besides discussion in Gerrit, > let's create a topic to discuss it in the IRC meeting tomorrow. > > Best regards > Ying Chun Guo (Daisy) > > > Akihiro Motoki <amotoki(a)gmail.com> wrote on 2015/11/17 20:00:13: > >> From: Akihiro Motoki <amotoki(a)gmail.com> >> To: "openstack-i18n(a)lists.openstack.org" >> <Openstack-i18n(a)lists.openstack.org> >> Date: 2015/11/17 20:28 >> Subject: [Openstack-i18n] RFC: draft doc on how to report translation bugs > >> >> Hi team, >> >> I proposed a doc patch on how to report a translation/I18N bugs. >> >> https://review.openstack.org/#/c/246256/ >> >> It discusses which and where bugs should be filed. >> I know we don't have any consensus on how to manage >> language-specific translation bugs. >> My draft is just a start-line and I don't think it is best. >> Any discussion and input would be appreciated. >> >> Thanks, >> Akihiro >> >> _______________________________________________ >> Openstack-i18n mailing list >> Openstack-i18n(a)lists.openstack.org >> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-i18n >> >

1 0