/[gentoo]/xml/htdocs/proj/en/glep/glep-0010.html
Gentoo

Diff of /xml/htdocs/proj/en/glep/glep-0010.html

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

Revision 1.1 Revision 1.3
7to templates. DO NOT USE THIS HTML FILE AS YOUR TEMPLATE! 7to templates. DO NOT USE THIS HTML FILE AS YOUR TEMPLATE!
8--> 8-->
9<head> 9<head>
10 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> 10 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
11 <meta name="generator" content="Docutils 0.3.0: http://docutils.sourceforge.net/" /> 11 <meta name="generator" content="Docutils 0.3.0: http://docutils.sourceforge.net/" />
12 <title>GLEP 10 -- Internationalization of www.gentoo.org</title> 12 <title>GLEP 10 -- Localized Gentoo Sites</title>
13 <link rel="stylesheet" href="tools/glep.css" type="text/css" /> 13 <link rel="stylesheet" href="tools/glep.css" type="text/css" />
14</head> 14</head>
15<body bgcolor="white"> 15<body bgcolor="white">
16<table class="navigation" cellpadding="0" cellspacing="0" 16<table class="navigation" cellpadding="0" cellspacing="0"
17 width="100%" border="0"> 17 width="100%" border="0">
29<col class="field-name" /> 29<col class="field-name" />
30<col class="field-body" /> 30<col class="field-body" />
31<tbody valign="top"> 31<tbody valign="top">
32<tr class="field"><th class="field-name">GLEP:</th><td class="field-body">10</td> 32<tr class="field"><th class="field-name">GLEP:</th><td class="field-body">10</td>
33</tr> 33</tr>
34<tr class="field"><th class="field-name">Title:</th><td class="field-body">Internationalization of www.gentoo.org</td> 34<tr class="field"><th class="field-name">Title:</th><td class="field-body">Localized Gentoo Sites</td>
35</tr> 35</tr>
36<tr class="field"><th class="field-name">Version:</th><td class="field-body">1.1</td> 36<tr class="field"><th class="field-name">Version:</th><td class="field-body">$Revision: 1.3 $</td>
37</tr> 37</tr>
38<tr class="field"><th class="field-name">Last-Modified:</th><td class="field-body"><a class="reference" href="http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/proj/en/glep/glep-0010.txt?cvsroot=gentoo">2003/08/04 18:03:54</a></td> 38<tr class="field"><th class="field-name">Last-Modified:</th><td class="field-body"><a class="reference" href="http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/proj/en/glep/glep-0010.txt?cvsroot=gentoo">$Date: 2004/05/02 21:15:23 $</a></td>
39</tr> 39</tr>
40<tr class="field"><th class="field-name">Author:</th><td class="field-body">Sven Vermeulen &lt;swift&#32;&#97;t&#32;gentoo.org&gt;</td> 40<tr class="field"><th class="field-name">Author:</th><td class="field-body">Tobias Scherbaum &lt;dertobi123&#32;&#97;t&#32;gentoo.org&gt;, Sven Vermeulen &lt;swift&#32;&#97;t&#32;gentoo.org&gt;</td>
41</tr> 41</tr>
42<tr class="field"><th class="field-name">Status:</th><td class="field-body">Draft</td> 42<tr class="field"><th class="field-name">Status:</th><td class="field-body">Draft</td>
43</tr> 43</tr>
44<tr class="field"><th class="field-name">Type:</th><td class="field-body">Standards Track</td>
45</tr>
46<tr class="field"><th class="field-name">Content-Type:</th><td class="field-body"><a class="reference" href="glep-0002.html">text/x-rst</a></td>
47</tr>
48<tr class="field"><th class="field-name">Created:</th><td class="field-body">4 Aug 2003</td> 44<tr class="field"><th class="field-name">Created:</th><td class="field-body">4-Aug-2003</td>
49</tr> 45</tr>
50<tr class="field"><th class="field-name">Post-History:</th><td class="field-body">4-Aug-2003</td> 46<tr class="field"><th class="field-name">Post-History:</th><td class="field-body">4-Aug-2003, 22-Aug-2003, 14-Mar-2004, 2-May-2004</td>
51</tr> 47</tr>
52</tbody> 48</tbody>
53</table> 49</table>
54<hr /> 50<hr />
55<div class="contents topic" id="contents"> 51<div class="contents topic" id="contents">
56<p class="topic-title"><a name="contents">Contents</a></p> 52<p class="topic-title"><a name="contents">Contents</a></p>
57<ul class="simple"> 53<ul class="simple">
58<li><a class="reference" href="#abstract" id="id11" name="id11">Abstract</a></li> 54<li><a class="reference" href="#abstract" id="id4" name="id4">Abstract:</a></li>
59<li><a class="reference" href="#motivation" id="id12" name="id12">Motivation</a></li> 55<li><a class="reference" href="#motivation" id="id5" name="id5">Motivation:</a></li>
60<li><a class="reference" href="#rationale" id="id13" name="id13">Rationale</a></li> 56<li><a class="reference" href="#rationale" id="id6" name="id6">Rationale:</a></li>
61<li><a class="reference" href="#implementation" id="id14" name="id14">Implementation</a><ul> 57<li><a class="reference" href="#implementation" id="id7" name="id7">Implementation:</a><ul>
62<li><a class="reference" href="#cvs-structure" id="id15" name="id15">CVS Structure</a></li>
63<li><a class="reference" href="#internationalized-website" id="id16" name="id16">Internationalized Website</a></li>
64<li><a class="reference" href="#permissions" id="id17" name="id17">Permissions</a></li> 58<li><a class="reference" href="#website-pages" id="id8" name="id8">Website Pages:</a><ul>
59<li><a class="reference" href="#requirements-for-small-localized-sites" id="id9" name="id9">Requirements for &quot;small&quot; localized sites:</a></li>
60<li><a class="reference" href="#requirements-for-big-localized-sites" id="id10" name="id10">Requirements for &quot;big&quot; localized sites:</a></li>
65</ul> 61</ul>
66</li> 62</li>
67<li><a class="reference" href="#backwards-compatibility" id="id18" name="id18">Backwards Compatibility</a></li>
68<li><a class="reference" href="#references" id="id19" name="id19">References</a></li> 63<li><a class="reference" href="#cvs-structure" id="id11" name="id11">CVS Structure:</a></li>
69<li><a class="reference" href="#copyright" id="id20" name="id20">Copyright</a></li> 64<li><a class="reference" href="#mail" id="id12" name="id12">Mail:</a></li>
65<li><a class="reference" href="#xsl" id="id13" name="id13">XSL:</a></li>
66</ul>
67</li>
70</ul> 68</ul>
71</div> 69</div>
72<div class="section" id="abstract"> 70<div class="section" id="abstract">
73<h1><a class="toc-backref" href="#id11" name="abstract">Abstract</a></h1> 71<h1><a class="toc-backref" href="#id4" name="abstract">Abstract:</a></h1>
74<p>The <a class="reference" href="http://www.gentoo.org">Gentoo web site</a> <a class="footnote-reference" href="#id3" id="id4" name="id4">[2]</a> is the main source of documentation regarding 72<p>The Gentoo Website <a class="footnote-reference" href="#gentoo" id="id1" name="id1">[1]</a> is the main source of documentation regarding
75Gentoo itself. It hosts all documents that the <a class="reference" href="http://www.gentoo.org/proj/en/gdp">Gentoo Documentation 73Gentoo itself. It hosts all documents that the Gentoo Documentation Project
76Project</a> <a class="footnote-reference" href="#id5" id="id6" name="id6">[3]</a> delivers, including all made translations.</p> 74<a class="footnote-reference" href="#gdp" id="id2" name="id2">[2]</a> delivers, including all made translations. In addition the website
77<p>This GLEP proposes a change in CVS structure regarding the documentation 75contains the GWN and its translations and several news items.</p>
78so that the individual translation teams can create a localized Gentoo
79website as proposed by <a class="reference" href="http://bugs.gentoo.org/show_bug.cgi?id=23199">Bug #23199</a> <a class="footnote-reference" href="#id7" id="id8" name="id8">[4]</a>.</p>
80</div> 76</div>
81<div class="section" id="motivation"> 77<div class="section" id="motivation">
82<h1><a class="toc-backref" href="#id12" name="motivation">Motivation</a></h1> 78<h1><a class="toc-backref" href="#id5" name="motivation">Motivation:</a></h1>
83<p>Lots of people have shown interest in the internationalization proposal, 79<p>Lots of people have shown interest in the localization proposal, and
84and even the infrastructure team has given positive feedback. However, 80even the infrastructure team has given positive feedback. However, due
85due to lack of a good roadmap and proposal this suggestion has never 81to lack of a good roadmap and proposal this suggestion has never grown
86grown beyond what it is now: a suggestion.</p> 82beyond what it is now: a suggestion. Between the first draft of this
87<p>The current CVS structure (and permissions) are insufficient to implement an 83proposal and now some communities grown faster than others. Actually it
88internationalized website. The current permissions are to broad while they 84is obvious that we have big communities (lots of users, lots of
89should be very strict, the current layout is too fragmented while it should be 85translators) and smaller communities (less users, less translators). If
90grouped together.</p> 86we speak about localized Gentoo sites we need to find a capable
87solution for small and even bigger communities. This leads us to a
88point where the lead translator can decide between a small localized
89site including necessarily translated documents and only some
90additional pages and a bigger variant with lots of translated gdp
91documents, translated news and gwn plus additional pages.</p>
91</div> 92</div>
92<div class="section" id="rationale"> 93<div class="section" id="rationale">
93<h1><a class="toc-backref" href="#id13" name="rationale">Rationale</a></h1> 94<h1><a class="toc-backref" href="#id6" name="rationale">Rationale:</a></h1>
94<p>The current layout regarding documentation in the CVS is as follows:</p> 95<p>The current layout regarding documentation in the CVS is as follows:</p>
95<pre class="literal-block"> 96<blockquote>
96[gentoo]/xml/htdocs/doc/en/* 97[gentoo]/xml/htdocs/doc/en/*
97[gentoo]/xml/htdocs/doc/nl/* 98[gentoo]/xml/htdocs/doc/nl/*
98[gentoo]/xml/htdocs/doc/fr/* 99[gentoo]/xml/htdocs/doc/fr/*</blockquote>
99... 100<p>However, there are several other documents (about, policy, etc) in
100</pre> 101main/$lang:</p>
101<p>However, the documentation index page itself (and several other 102<blockquote>
102important parts of the Gentoo website) are structed like this:</p>
103<pre class="literal-block">
104[gentoo]/xml/htdocs/main/en/* 103[gentoo]/xml/htdocs/main/en/*
105[gentoo]/xml/htdocs/main/nl/* 104[gentoo]/xml/htdocs/main/nl/*
106[gentoo]/xml/htdocs/main/fr/* 105[gentoo]/xml/htdocs/main/fr/*</blockquote>
107...
108</pre>
109<p>This structure makes it very difficult for assigning permissions to the 106<p>This structure makes it very difficult for assigning permissions to the
110individual translation teams, and even more difficult to really localise 107individual translation teams, and even more difficult to really localize
111the Gentoo Website. At this very moment, the translation teams can edit 108the Gentoo Website. At this very moment, the translation teams can edit
112documents of other languages or even the master English documents. English 109documents of other languages or even the master English documents. English
113reviewers and editors can touch documents of languages they possibly don't 110reviewers and editors can touch documents of languages they possibly don't
114even know. Although we do trust every single documentation editor, a better 111even know. Although we do trust every single documentation editor, a better
115implementation is advisable.</p> 112implementation is advisable. We also can't give access to well-known
113but non-dev translators.</p>
116<p>We want to restructure the current layout so that the Gentoo Website is 114<p>We want to restructure the current layout so that the Gentoo Website is
117more easily internationalized.</p> 115more easily internationalized.</p>
118</div> 116</div>
119<div class="section" id="implementation"> 117<div class="section" id="implementation">
120<h1><a class="toc-backref" href="#id14" name="implementation">Implementation</a></h1> 118<h1><a class="toc-backref" href="#id7" name="implementation">Implementation:</a></h1>
119<div class="section" id="website-pages">
120<h2><a class="toc-backref" href="#id8" name="website-pages">Website Pages:</a></h2>
121<p>The Lead Translator can choose if he wants to maintain a &quot;small&quot; or a
122&quot;big&quot; localized site. All localized sites will be accessible on
123<a class="reference" href="http://$lang.gentoo.org">http://$lang.gentoo.org</a> which will point to [gentoo]xml/htdocs/$lang.
124All localized sites must be implemented in GuideXML.</p>
125<div class="section" id="requirements-for-small-localized-sites">
126<h3><a class="toc-backref" href="#id9" name="requirements-for-small-localized-sites">Requirements for &quot;small&quot; localized sites:</a></h3>
127<blockquote>
128<ul class="simple">
129<li>all documents marked as required in our Translators Howto</li>
130<li>$lang/main/translators.xml, listing of all translators (including
131GWN translators)</li>
132<li>$lang/main/communities.xml, listing of all community sites available in $lang</li>
133<li>index.xml &quot;welcome page&quot;, listing of available ressources on
134$lang.gentoo.org (i.e. links to documentation, translators.xml and
135communities.xml)</li>
136</ul>
137</blockquote>
138</div>
139<div class="section" id="requirements-for-big-localized-sites">
140<h3><a class="toc-backref" href="#id10" name="requirements-for-big-localized-sites">Requirements for &quot;big&quot; localized sites:</a></h3>
141<blockquote>
142<ul class="simple">
143<li>all documents marked as required in our Translators Howto</li>
144<li>$lang/main/translators.xml, listing of all translators (including
145GWN translators)</li>
146<li>$lang/main/communities.xml, listing of all community sites available in $lang</li>
147<li>translated $lang/main documents</li>
148<li>translated $lang/news/gwn</li>
149<li>translated news items ($lang/news) (only translated news items,
150news items on a per-lang basis aren't allowed)</li>
151</ul>
152</blockquote>
153</div>
154</div>
121<div class="section" id="cvs-structure"> 155<div class="section" id="cvs-structure">
122<h2><a class="toc-backref" href="#id15" name="cvs-structure">CVS Structure</a></h2> 156<h2><a class="toc-backref" href="#id11" name="cvs-structure">CVS Structure:</a></h2>
123<p>A better implementation is to fully seperate each language from the 157<p>Actual scheme, everything is relative to [gentoo]/xml/htdocs:</p>
124other. For instance:</p>
125<pre class="literal-block"> 158<pre class="literal-block">
126[gentoo]/xml/htdocs/en/doc 159main/en Contains the main Gentoo Website (about, policy, lists, etc.)
127[gentoo]/xml/htdocs/en/main 160main/$lang Contains some translated Website pages
128[gentoo]/xml/htdocs/en/proj 161doc/en Contains the master English Documentation
129... 162doc/$lang Contains the translated Documentation
130[gentoo]/xml/htdocs/nl/doc 163news Contains English news items
131[gentoo]/xml/htdocs/nl/main 164news/en/gwn Contains the master English GWNs
132[gentoo]/xml/htdocs/nl/proj 165news/$lang/gwn Contains translated GWNs
133... 166proj/en Contains the project Webpages
134[gentoo]/xml/htdocs/fr/doc
135[gentoo]/xml/htdocs/fr/main
136[gentoo]/xml/htdocs/fr/proj
137...
138</pre> 167</pre>
139<p>This implementation has several advantages:</p> 168<p>Proposed scheme, relative to [gentoo]/xml/htdocs:</p>
140<ul>
141<li><p class="first">Easy (and more secure) CVS permissions</p>
142<p>Every translation team can now be contained in its own group regarding
143permissions. That group has access to the full
144[gentoo]/xml/htdocs/${LANGUAGE} directory and subdirectories. Other
145languages (including English) cannot be touched by the translation
146teams.</p>
147</li>
148<li><p class="first">Better integration regarding the website</p>
149<p>Currently, the website's <a class="reference" href="http://www.gentoo.org/main/en/docs.xml">documentation page</a> <a class="footnote-reference" href="#id9" id="id10" name="id10">[5]</a> lists all translations
150too. Every time a new translation is uploaded, the links are adjusted.
151With the new structure, the translation teams are in charge of their
152own documentation page which can be found through
153<a class="reference" href="http://www.gentoo.org">http://www.gentoo.org</a>/${LANGUAGE}/main/docs.xml.</p>
154</li>
155<li><p class="first">Internationalization of the website</p>
156<p>In this stadium <a class="reference" href="http://www.gentoo.org">http://www.gentoo.org</a>/${LANGUAGE} would host the
157internationalized Gentoo web site. The infrastructure-team would then
158make sure that <a class="reference" href="http:/">http:/</a>/${LANGUAGE}.gentoo.org refers to the
159beforementioned URL.</p>
160</li>
161</ul>
162<p>This CVS restructure shouldn't take much time, it does require an atomic
163move of the existing directories, meaning CVS access for all affected
164parties (and this <em>includes</em> the Gentoo Project webpages) would be
165unavailable during the transition. It also requires a rewrite of permissions
166which is discussed further down this GLEP.</p>
167</div>
168<div class="section" id="internationalized-website">
169<h2><a class="toc-backref" href="#id16" name="internationalized-website">Internationalized Website</a></h2>
170<p>The Gentoo web servers (and their update-pace) aren't created for
171high-volume data transfers or updates. Therefor a consensus was made
172that the teams in charge of the internationalization of the Gentoo web
173site (in this proposal the translation teams) would not create a
174blog-like situation, but link existing localised gentoo communities <a class="footnote-reference" href="#id2" id="id1" name="id1">[1]</a>
175from the <a class="reference" href="http:/">http:/</a>/${LANGUAGE}.gentoo.org website.</p>
176<p>Some people might ask why we wouldn't just have
177<a class="reference" href="http:/">http:/</a>/${LANGUAGE}.gentoo.org refer (through DNS or otherwise) to the
178respective community site. This is because that implementation is only
179plausible if there is only one community site regarding the
180language/country. However, there can be several such community sites,
181and providing one with the referral and not the other would be
182discriminating.</p>
183</div>
184<div class="section" id="permissions">
185<h2><a class="toc-backref" href="#id17" name="permissions">Permissions</a></h2>
186<p>The proposed implementation would result in the following possible
187permission scheme (all read/write):</p>
188<pre class="literal-block"> 169<pre class="literal-block">
189cvswebdoc: [gentoo]/xml/htdocs/en/main and [gentoo]/xml/htdocs/en/doc 170$lang/main Contains some translated Website pages
190cvsnlweb: [gentoo]/xml/htdocs/nl 171$lang/doc Contains the translated Documentation
191cvsfrweb: [gentoo]/xml/htdocs/fr 172$lang/news Contains translated news items
192... 173$lang/news/gwn Contains translated GWNs
193cvskernel: [gentoo]/xml/htdocs/en/proj/kernel
194cvsgdp: [gentoo]/xml/htdocs/en/proj/gdp
195cvsinfrastruct: [gentoo]/xml/htdocs/en/proj/infrastructure
196</pre> 174</pre>
197<p>As you can see, the translation teams are in charge of the whole
198internationalization: translation of website, projects, documentation.</p>
199<p>The English documentation team is contained in cvswebdoc and has access
200to the doc/ subdirectory (in which the documentation resides) and the
201main/ subdirectory (in which the docs.xml page and others reside).</p>
202<p>The project web pages themselves are contained in seperate groups as is
203currently the case.</p>
204</div> 175</div>
176<div class="section" id="mail">
177<h2><a class="toc-backref" href="#id12" name="mail">Mail:</a></h2>
178<p>All mails to <a class="reference" href="mailto:www-$lang&#64;gentoo.org">www-$lang&#64;gentoo.org</a> should be forwarded to the Lead
179Translator and his Follow-Up.</p>
205</div> 180</div>
206<div class="section" id="backwards-compatibility">
207<h1><a class="toc-backref" href="#id18" name="backwards-compatibility">Backwards Compatibility</a></h1>
208<p>Although nothing gets lost, the new implementation is not compatible with the
209current one. However, due to the nature of documentation (and website) this is
210not a problem.</p>
211</div>
212<div class="section" id="references"> 181<div class="section" id="xsl">
213<h1><a class="toc-backref" href="#id19" name="references">References</a></h1> 182<h2><a class="toc-backref" href="#id13" name="xsl">XSL:</a></h2>
183<p>We need to &quot;hack&quot; our guide.xsl to support something like inserts.xml for the
184whole site.</p>
214<table class="footnote" frame="void" id="id2" rules="none"> 185<table class="footnote" frame="void" id="gentoo" rules="none">
215<colgroup><col class="label" /><col /></colgroup> 186<colgroup><col class="label" /><col /></colgroup>
216<tbody valign="top"> 187<tbody valign="top">
217<tr><td class="label"><a class="fn-backref" href="#id1" name="id2">[1]</a></td><td>A sum of such community sites can be found at 188<tr><td class="label"><a class="fn-backref" href="#id1" name="gentoo">[1]</a></td><td><a class="reference" href="http://www.gentoo.org">http://www.gentoo.org</a></td></tr>
218<a class="reference" href="http://dev.gentoo.org/~liquidx/communities.html">http://dev.gentoo.org/~liquidx/communities.html</a></td></tr>
219</tbody> 189</tbody>
220</table> 190</table>
221<table class="footnote" frame="void" id="id3" rules="none"> 191<table class="footnote" frame="void" id="gdp" rules="none">
222<colgroup><col class="label" /><col /></colgroup> 192<colgroup><col class="label" /><col /></colgroup>
223<tbody valign="top"> 193<tbody valign="top">
224<tr><td class="label"><a class="fn-backref" href="#id4" name="id3">[2]</a></td><td><a class="reference" href="http://www.gentoo.org">http://www.gentoo.org</a></td></tr> 194<tr><td class="label"><a class="fn-backref" href="#id2" name="gdp">[2]</a></td><td><a class="reference" href="http://gdp.gentoo.org">http://gdp.gentoo.org</a></td></tr>
225</tbody> 195</tbody>
226</table> 196</table>
227<table class="footnote" frame="void" id="id5" rules="none">
228<colgroup><col class="label" /><col /></colgroup>
229<tbody valign="top">
230<tr><td class="label"><a class="fn-backref" href="#id6" name="id5">[3]</a></td><td><a class="reference" href="http://www.gentoo.org/proj/en/gdp">http://www.gentoo.org/proj/en/gdp</a></td></tr>
231</tbody>
232</table>
233<table class="footnote" frame="void" id="id7" rules="none">
234<colgroup><col class="label" /><col /></colgroup>
235<tbody valign="top">
236<tr><td class="label"><a class="fn-backref" href="#id8" name="id7">[4]</a></td><td><a class="reference" href="http://bugs.gentoo.org/show_bug.cgi?id=23199">http://bugs.gentoo.org/show_bug.cgi?id=23199</a></td></tr>
237</tbody>
238</table>
239<table class="footnote" frame="void" id="id9" rules="none">
240<colgroup><col class="label" /><col /></colgroup>
241<tbody valign="top">
242<tr><td class="label"><a class="fn-backref" href="#id10" name="id9">[5]</a></td><td><a class="reference" href="http://www.gentoo.org/main/en/docs.xml">http://www.gentoo.org/main/en/docs.xml</a></td></tr>
243</tbody>
244</table>
245</div> 197</div>
246<div class="section" id="copyright">
247<h1><a class="toc-backref" href="#id20" name="copyright">Copyright</a></h1>
248<p>This document has been placed in the public domain.</p>
249</div> 198</div>
250</div> 199</div>
251 200
252<hr class="footer"/> 201<hr class="footer"/>
253<div class="footer"> 202<div class="footer">
254<a class="reference" href="glep-0010.txt">View document source</a>. 203<a class="reference" href="glep-0010.txt">View document source</a>.
255Generated on: 2003-08-04 18:18 UTC. 204Generated on: 2004-05-02 21:14 UTC.
256Generated by <a class="reference" href="http://docutils.sourceforge.net/">Docutils</a> from <a class="reference" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> source. 205Generated by <a class="reference" href="http://docutils.sourceforge.net/">Docutils</a> from <a class="reference" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> source.
257</div> 206</div>
258</body> 207</body>
259</html> 208</html>
260 209

Legend:
Removed from v.1.1  
changed lines
  Added in v.1.3

  ViewVC Help
Powered by ViewVC 1.1.20