https://jira.whamcloud.com This file is an XML representation of an issue en-us 9.4.14 940014 05-12-2023 https://jira.whamcloud.com/browse/LUDOC-238 Lustre Documentation <p>I am from Russia, and now i am translating Gentoo Linux Handbook and Wiki to Russian language. I am interested in Lustre also, and want to learn it. As the best way to learn is to read documentation, i want to translate Lustre docs also (to Russian). Is this possible, and if yes, then how? (I know, that i can take docs, translate it and put it on my own site, but i want to share docs with community, if it is possible on this site).</p> LUDOC-238

Translate documentation to Russian

Improvement Minor Resolved Incomplete Richard Henwood Vladimir Romanov Thu, 3 Apr 2014 12:20:46 +0000 Thu, 24 Mar 2016 19:11:34 +0000 Thu, 24 Mar 2016 19:11:34 +0000 0 3 <p>Hi Vladimir,</p> <p>Lustre docs are marked up as Docbook 5 XML. Docbook 5 has a mechanism for adding additional languages described here: <a href="http://www.sagehill.net/docbookxsl/Localizations.html" class="external-link" target="_blank" rel="nofollow noopener">http://www.sagehill.net/docbookxsl/Localizations.html</a></p> <p>Currently, in my opinion, the documentation project is not well prepared to begin a translation effort for the reasons:</p> <p>+ the current manual is in a single directory. To accommodate multiple languages cleanly, we should re-factor the manual structure - probably following the publican model. <a href="http://jfearn.fedorapeople.org/en-US/Publican/4.0/html/Users_Guide/" class="external-link" target="_blank" rel="nofollow noopener">http://jfearn.fedorapeople.org/en-US/Publican/4.0/html/Users_Guide/</a></p> <p>+ the current English language manual has not achieved quiescence: i.e. there are a large number of changes that are arriving. Any translation effort would need to track a moving target.</p> <p>There are a number of existing tasks that need attention: <a href="https://jira.hpdd.intel.com/browse/LUDOC" class="external-link" target="_blank" rel="nofollow noopener">https://jira.hpdd.intel.com/browse/LUDOC</a> . Tackling one of these tasks is a great introduction to a particular part of the Lustre file system and the documentation workflow. Are there any that are of interest?</p> <p>richard,</p> <p>It's fine about large number of changes. I will handle it.<br/> So, i need to translate large amount of text, you need to refactor manual structure. Why not take a break for example, for 2-3 months? I will translate some reasonable amount of text, you will think, how to refactor properly. Then we will meet again, and will do something with translation?</p> <p>Hi Vladimir,</p> <p>I admire your enthusiasm! </p> <p>I do want to set your expectations with regard to workflow we are committed to for both Lustre software source code changes and the Operations Manual changes:</p> <p>All changes must complete a successful review by two reviewers with suitable experience. Assuming the Publican re-factoring work can be completed in time, my biggest practical concern is that you would complete your work and there is no one available to provide the review.</p> <p>As you pointed out - your efforts would not be wasted if reviewers cannot be found. You can share your version of the manual under the same license as our version of the manual... but I want to do my best to ensure your work is integrated in a single manual.</p> <p>Can I try again and suggest you choose an existing LUDOC ticket to get a feel for the work-flow and have something to show quickly? This will also give me an opportunity to plan a time line for moving to Publican.</p> <p>How can i fix existing LUDOC? To fix LUDOC i need to dig into documentation and learn about how Lustre works. If i will learn, how it is works, then i can just install it to my servers and use it.<br/> I want to learn it and learn together with translation. So, when the translation ends (of course, there will be updates over time), i will understand, how Lustre works.</p> <p>Proposal: If i need to feel the work-flow, but i don't know Lustre yet. Can i translate ALL of docs, put them in some site. As it will take long time, you, of course, will move to Publican by that time (with me, or without me). Then (as i will know Lustre by that time), i will fix some amount of LUDOC issues, and we will merge the docs?</p> <p>Sounds good. </p> <p>One request:</p> <p>When you are going through your process - please file an LUDOC for any issues you find with the current manual.</p> <p>... and one detail:</p> <p>/I/ can not promise to merge docs - we have a peer review process that all changes must go through before merging.</p> <p>Stay in touch - and let me know how it goes!</p> <p>Haven't seen any updates here in two years, please reopen if there is some progress.</p> Blocker Development Rank 1|hzwj6f: Rank (Obsolete) 13396