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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.1 - (hide annotations) (download)
Mon Aug 4 18:03:54 2003 UTC (10 years, 8 months ago) by g2boojum
Branch: MAIN
File MIME type: text/plain
new glep

1 g2boojum 1.1 GLEP: 10
2     Title: Internationalization of www.gentoo.org
3     Version: $Revision: $
4     Last-Modified: $Date: $
5     Author: Sven Vermeulen <swift@gentoo.org>
6     Status: Draft
7     Type: Standards Track
8     Content-Type: text/x-rst
9     Created: 4 Aug 2003
10     Post-History: 4-Aug-2003
11    
12     Abstract
13     ========
14    
15     The `Gentoo web site`_ is the main source of documentation regarding
16     Gentoo itself. It hosts all documents that the `Gentoo Documentation
17     Project`_ delivers, including all made translations.
18    
19     .. _Gentoo web site: http://www.gentoo.org
20     .. _Gentoo Documentation Project: http://www.gentoo.org/proj/en/gdp
21    
22     This GLEP proposes a change in CVS structure regarding the documentation
23     so that the individual translation teams can create a localized Gentoo
24     website as proposed by `Bug #23199`_.
25    
26     .. _Bug #23199: http://bugs.gentoo.org/show_bug.cgi?id=23199
27    
28     Motivation
29     ==========
30    
31     Lots of people have shown interest in the internationalization proposal,
32     and even the infrastructure team has given positive feedback. However,
33     due to lack of a good roadmap and proposal this suggestion has never
34     grown beyond what it is now: a suggestion.
35    
36     The current CVS structure (and permissions) are insufficient to implement an
37     internationalized website. The current permissions are to broad while they
38     should be very strict, the current layout is too fragmented while it should be
39     grouped together.
40    
41     Rationale
42     =========
43    
44     The current layout regarding documentation in the CVS is as follows::
45    
46     [gentoo]/xml/htdocs/doc/en/*
47     [gentoo]/xml/htdocs/doc/nl/*
48     [gentoo]/xml/htdocs/doc/fr/*
49     ...
50    
51     However, the documentation index page itself (and several other
52     important parts of the Gentoo website) are structed like this::
53    
54     [gentoo]/xml/htdocs/main/en/*
55     [gentoo]/xml/htdocs/main/nl/*
56     [gentoo]/xml/htdocs/main/fr/*
57     ...
58    
59     This structure makes it very difficult for assigning permissions to the
60     individual translation teams, and even more difficult to really localise
61     the Gentoo Website. At this very moment, the translation teams can edit
62     documents of other languages or even the master English documents. English
63     reviewers and editors can touch documents of languages they possibly don't
64     even know. Although we do trust every single documentation editor, a better
65     implementation is advisable.
66    
67     We want to restructure the current layout so that the Gentoo Website is
68     more easily internationalized.
69    
70     Implementation
71     ==============
72    
73     CVS Structure
74     -------------
75    
76     A better implementation is to fully seperate each language from the
77     other. For instance::
78    
79     [gentoo]/xml/htdocs/en/doc
80     [gentoo]/xml/htdocs/en/main
81     [gentoo]/xml/htdocs/en/proj
82     ...
83     [gentoo]/xml/htdocs/nl/doc
84     [gentoo]/xml/htdocs/nl/main
85     [gentoo]/xml/htdocs/nl/proj
86     ...
87     [gentoo]/xml/htdocs/fr/doc
88     [gentoo]/xml/htdocs/fr/main
89     [gentoo]/xml/htdocs/fr/proj
90     ...
91    
92     This implementation has several advantages:
93    
94     * Easy (and more secure) CVS permissions
95    
96     Every translation team can now be contained in its own group regarding
97     permissions. That group has access to the full
98     [gentoo]/xml/htdocs/${LANGUAGE} directory and subdirectories. Other
99     languages (including English) cannot be touched by the translation
100     teams.
101    
102     * Better integration regarding the website
103    
104     Currently, the website's `documentation page`_ lists all translations
105     too. Every time a new translation is uploaded, the links are adjusted.
106     With the new structure, the translation teams are in charge of their
107     own documentation page which can be found through
108     http://www.gentoo.org/${LANGUAGE}/main/docs.xml.
109    
110     * Internationalization of the website
111    
112     In this stadium http://www.gentoo.org/${LANGUAGE} would host the
113     internationalized Gentoo web site. The infrastructure-team would then
114     make sure that http://${LANGUAGE}.gentoo.org refers to the
115     beforementioned URL.
116    
117     .. _documentation page: http://www.gentoo.org/main/en/docs.xml
118    
119     This CVS restructure shouldn't take much time, it does require an atomic
120     move of the existing directories, meaning CVS access for all affected
121     parties (and this *includes* the Gentoo Project webpages) would be
122     unavailable during the transition. It also requires a rewrite of permissions
123     which is discussed further down this GLEP.
124    
125    
126     Internationalized Website
127     -------------------------
128    
129     The Gentoo web servers (and their update-pace) aren't created for
130     high-volume data transfers or updates. Therefor a consensus was made
131     that the teams in charge of the internationalization of the Gentoo web
132     site (in this proposal the translation teams) would not create a
133     blog-like situation, but link existing localised gentoo communities [1]_
134     from the http://${LANGUAGE}.gentoo.org website.
135    
136     Some people might ask why we wouldn't just have
137     http://${LANGUAGE}.gentoo.org refer (through DNS or otherwise) to the
138     respective community site. This is because that implementation is only
139     plausible if there is only one community site regarding the
140     language/country. However, there can be several such community sites,
141     and providing one with the referral and not the other would be
142     discriminating.
143    
144     Permissions
145     -----------
146    
147     The proposed implementation would result in the following possible
148     permission scheme (all read/write)::
149    
150     cvswebdoc: [gentoo]/xml/htdocs/en/main and [gentoo]/xml/htdocs/en/doc
151     cvsnlweb: [gentoo]/xml/htdocs/nl
152     cvsfrweb: [gentoo]/xml/htdocs/fr
153     ...
154     cvskernel: [gentoo]/xml/htdocs/en/proj/kernel
155     cvsgdp: [gentoo]/xml/htdocs/en/proj/gdp
156     cvsinfrastruct: [gentoo]/xml/htdocs/en/proj/infrastructure
157    
158     As you can see, the translation teams are in charge of the whole
159     internationalization: translation of website, projects, documentation.
160    
161     The English documentation team is contained in cvswebdoc and has access
162     to the doc/ subdirectory (in which the documentation resides) and the
163     main/ subdirectory (in which the docs.xml page and others reside).
164    
165     The project web pages themselves are contained in seperate groups as is
166     currently the case.
167    
168     Backwards Compatibility
169     =======================
170    
171     Although nothing gets lost, the new implementation is not compatible with the
172     current one. However, due to the nature of documentation (and website) this is
173     not a problem.
174    
175     References
176     ==========
177    
178     .. [1] A sum of such community sites can be found at
179     http://dev.gentoo.org/~liquidx/communities.html
180    
181     Copyright
182     =========
183    
184     This document has been placed in the public domain.

  ViewVC Help
Powered by ViewVC 1.1.20