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

Parent Directory Parent Directory | Revision Log Revision Log

Revision 1.1 - (show annotations) (download) (as text)
Mon Aug 4 18:27:15 2003 UTC (14 years, 10 months ago) by g2boojum
Branch: MAIN
File MIME type: text/html
New glep

1 <?xml version="1.0" encoding="utf-8" ?>
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4 <!--
5 This HTML is auto-generated. DO NOT EDIT THIS FILE! If you are writing a new
6 PEP, see http://www.python.org/peps/pep-0001.html for instructions and links
8 -->
9 <head>
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/" />
12 <title>GLEP 10 -- Internationalization of www.gentoo.org</title>
13 <link rel="stylesheet" href="tools/glep.css" type="text/css" />
14 </head>
15 <body bgcolor="white">
16 <table class="navigation" cellpadding="0" cellspacing="0"
17 width="100%" border="0">
18 <tr><td class="navicon" width="150" height="35">
19 <a href="http://www.gentoo.org/" title="Gentoo Linux Home Page">
20 <img src="http://www.gentoo.org/images/gentoo-new.gif" alt="[Gentoo]"
21 border="0" width="150" height="35" /></a></td>
22 <td class="textlinks" align="left">
23 [<b><a href="http://www.gentoo.org/">Gentoo Linux Home</a></b>]
24 [<b><a href="http://www.gentoo.org/proj/en/glep">GLEP Index</a></b>]
25 [<b><a href="http://www.gentoo.org/proj/en/glep/glep-0010.txt">GLEP Source</a></b>]
26 </td></tr></table>
27 <div class="document">
28 <table class="rfc2822 field-list" frame="void" rules="none">
29 <col class="field-name" />
30 <col class="field-body" />
31 <tbody valign="top">
32 <tr class="field"><th class="field-name">GLEP:</th><td class="field-body">10</td>
33 </tr>
34 <tr class="field"><th class="field-name">Title:</th><td class="field-body">Internationalization of www.gentoo.org</td>
35 </tr>
36 <tr class="field"><th class="field-name">Version:</th><td class="field-body">1.1</td>
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>
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>
41 </tr>
42 <tr class="field"><th class="field-name">Status:</th><td class="field-body">Draft</td>
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>
49 </tr>
50 <tr class="field"><th class="field-name">Post-History:</th><td class="field-body">4-Aug-2003</td>
51 </tr>
52 </tbody>
53 </table>
54 <hr />
55 <div class="contents topic" id="contents">
56 <p class="topic-title"><a name="contents">Contents</a></p>
57 <ul class="simple">
58 <li><a class="reference" href="#abstract" id="id11" name="id11">Abstract</a></li>
59 <li><a class="reference" href="#motivation" id="id12" name="id12">Motivation</a></li>
60 <li><a class="reference" href="#rationale" id="id13" name="id13">Rationale</a></li>
61 <li><a class="reference" href="#implementation" id="id14" name="id14">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>
65 </ul>
66 </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>
69 <li><a class="reference" href="#copyright" id="id20" name="id20">Copyright</a></li>
70 </ul>
71 </div>
72 <div class="section" id="abstract">
73 <h1><a class="toc-backref" href="#id11" 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
75 Gentoo itself. It hosts all documents that the <a class="reference" href="http://www.gentoo.org/proj/en/gdp">Gentoo Documentation
76 Project</a> <a class="footnote-reference" href="#id5" id="id6" name="id6">[3]</a> delivers, including all made translations.</p>
77 <p>This GLEP proposes a change in CVS structure regarding the documentation
78 so that the individual translation teams can create a localized Gentoo
79 website 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>
81 <div class="section" id="motivation">
82 <h1><a class="toc-backref" href="#id12" name="motivation">Motivation</a></h1>
83 <p>Lots of people have shown interest in the internationalization proposal,
84 and even the infrastructure team has given positive feedback. However,
85 due to lack of a good roadmap and proposal this suggestion has never
86 grown beyond what it is now: a suggestion.</p>
87 <p>The current CVS structure (and permissions) are insufficient to implement an
88 internationalized website. The current permissions are to broad while they
89 should be very strict, the current layout is too fragmented while it should be
90 grouped together.</p>
91 </div>
92 <div class="section" id="rationale">
93 <h1><a class="toc-backref" href="#id13" name="rationale">Rationale</a></h1>
94 <p>The current layout regarding documentation in the CVS is as follows:</p>
95 <pre class="literal-block">
96 [gentoo]/xml/htdocs/doc/en/*
97 [gentoo]/xml/htdocs/doc/nl/*
98 [gentoo]/xml/htdocs/doc/fr/*
99 ...
100 </pre>
101 <p>However, the documentation index page itself (and several other
102 important parts of the Gentoo website) are structed like this:</p>
103 <pre class="literal-block">
104 [gentoo]/xml/htdocs/main/en/*
105 [gentoo]/xml/htdocs/main/nl/*
106 [gentoo]/xml/htdocs/main/fr/*
107 ...
108 </pre>
109 <p>This structure makes it very difficult for assigning permissions to the
110 individual translation teams, and even more difficult to really localise
111 the Gentoo Website. At this very moment, the translation teams can edit
112 documents of other languages or even the master English documents. English
113 reviewers and editors can touch documents of languages they possibly don't
114 even know. Although we do trust every single documentation editor, a better
115 implementation is advisable.</p>
116 <p>We want to restructure the current layout so that the Gentoo Website is
117 more easily internationalized.</p>
118 </div>
119 <div class="section" id="implementation">
120 <h1><a class="toc-backref" href="#id14" name="implementation">Implementation</a></h1>
121 <div class="section" id="cvs-structure">
122 <h2><a class="toc-backref" href="#id15" name="cvs-structure">CVS Structure</a></h2>
123 <p>A better implementation is to fully seperate each language from the
124 other. For instance:</p>
125 <pre class="literal-block">
126 [gentoo]/xml/htdocs/en/doc
127 [gentoo]/xml/htdocs/en/main
128 [gentoo]/xml/htdocs/en/proj
129 ...
130 [gentoo]/xml/htdocs/nl/doc
131 [gentoo]/xml/htdocs/nl/main
132 [gentoo]/xml/htdocs/nl/proj
133 ...
134 [gentoo]/xml/htdocs/fr/doc
135 [gentoo]/xml/htdocs/fr/main
136 [gentoo]/xml/htdocs/fr/proj
137 ...
138 </pre>
139 <p>This implementation has several advantages:</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
143 permissions. That group has access to the full
144 [gentoo]/xml/htdocs/${LANGUAGE} directory and subdirectories. Other
145 languages (including English) cannot be touched by the translation
146 teams.</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
150 too. Every time a new translation is uploaded, the links are adjusted.
151 With the new structure, the translation teams are in charge of their
152 own 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
157 internationalized Gentoo web site. The infrastructure-team would then
158 make sure that <a class="reference" href="http:/">http:/</a>/${LANGUAGE}.gentoo.org refers to the
159 beforementioned URL.</p>
160 </li>
161 </ul>
162 <p>This CVS restructure shouldn't take much time, it does require an atomic
163 move of the existing directories, meaning CVS access for all affected
164 parties (and this <em>includes</em> the Gentoo Project webpages) would be
165 unavailable during the transition. It also requires a rewrite of permissions
166 which 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
171 high-volume data transfers or updates. Therefor a consensus was made
172 that the teams in charge of the internationalization of the Gentoo web
173 site (in this proposal the translation teams) would not create a
174 blog-like situation, but link existing localised gentoo communities <a class="footnote-reference" href="#id2" id="id1" name="id1">[1]</a>
175 from 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
178 respective community site. This is because that implementation is only
179 plausible if there is only one community site regarding the
180 language/country. However, there can be several such community sites,
181 and providing one with the referral and not the other would be
182 discriminating.</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
187 permission scheme (all read/write):</p>
188 <pre class="literal-block">
189 cvswebdoc: [gentoo]/xml/htdocs/en/main and [gentoo]/xml/htdocs/en/doc
190 cvsnlweb: [gentoo]/xml/htdocs/nl
191 cvsfrweb: [gentoo]/xml/htdocs/fr
192 ...
193 cvskernel: [gentoo]/xml/htdocs/en/proj/kernel
194 cvsgdp: [gentoo]/xml/htdocs/en/proj/gdp
195 cvsinfrastruct: [gentoo]/xml/htdocs/en/proj/infrastructure
196 </pre>
197 <p>As you can see, the translation teams are in charge of the whole
198 internationalization: translation of website, projects, documentation.</p>
199 <p>The English documentation team is contained in cvswebdoc and has access
200 to the doc/ subdirectory (in which the documentation resides) and the
201 main/ 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
203 currently the case.</p>
204 </div>
205 </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
209 current one. However, due to the nature of documentation (and website) this is
210 not a problem.</p>
211 </div>
212 <div class="section" id="references">
213 <h1><a class="toc-backref" href="#id19" name="references">References</a></h1>
214 <table class="footnote" frame="void" id="id2" rules="none">
215 <colgroup><col class="label" /><col /></colgroup>
216 <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
218 <a class="reference" href="http://dev.gentoo.org/~liquidx/communities.html">http://dev.gentoo.org/~liquidx/communities.html</a></td></tr>
219 </tbody>
220 </table>
221 <table class="footnote" frame="void" id="id3" rules="none">
222 <colgroup><col class="label" /><col /></colgroup>
223 <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>
225 </tbody>
226 </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>
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>
250 </div>
252 <hr class="footer"/>
253 <div class="footer">
254 <a class="reference" href="glep-0010.txt">View document source</a>.
255 Generated on: 2003-08-04 18:18 UTC.
256 Generated 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>
258 </body>
259 </html>

  ViewVC Help
Powered by ViewVC 1.1.20