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

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

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

Revision 1.2 Revision 1.4
1GLEP: 10 1GLEP: 10
2Title: Localization for Gentoo Community 2Title: Localized Gentoo Sites
3Version: $Revision: 1.2 $ 3Version: $Revision: 1.4 $
4Last-Modified: $Date: 2003/08/24 22:11:46 $ 4Last-Modified: $Date: 2004/08/22 13:57:11 $
5Author: Sven Vermeulen <swift@gentoo.org> 5Author: Tobias Scherbaum <dertobi123@gentoo.org>, Sven Vermeulen <swift@gentoo.org>
6Status: Draft 6Status: deferred
7Type: Standards Track
8Content-Type: text/x-rst
9Created: 4 Aug 2003 7Created: 4-Aug-2003
10Post-History: 4-Aug-2003, 22-Aug-2003 8Post-History: 4-Aug-2003, 22-Aug-2003, 14-Mar-2004, 2-May-2004, 22-Aug-2004
11 9
12Abstract
13========
14 10
15The `Gentoo web site`_ is the main source of documentation regarding 11Status
16Gentoo itself. It hosts all documents that the `Gentoo Documentation 12======
17Project`_ delivers, including all made translations.
18 13
19.. _Gentoo web site: http://www.gentoo.org 14Due to insufficient resources, the doc team is unable to implement
20.. _Gentoo Documentation Project: http://www.gentoo.org/proj/en/gdp 15this GLEP at this time. It has therefore been marked "deferred".
21 16
22This GLEP proposes some changes regarding the documentation 17Abstract:
23so that we can provide our international users with information regarding 18=========
24Gentoo Communities, as proposed by `Bug #23199`_.
25 19
26.. _Bug #23199: http://bugs.gentoo.org/show_bug.cgi?id=23199 20The Gentoo Website [#gentoo]_ is the main source of documentation regarding
21Gentoo itself. It hosts all documents that the Gentoo Documentation Project
22[#gdp]_ delivers, including all made translations. In addition the website
23contains the GWN and its translations and several news items.
27 24
25
28Motivation 26Motivation:
27===========
28
29Lots of people have shown interest in the localization proposal, and
30even the infrastructure team has given positive feedback. However, due
31to lack of a good roadmap and proposal this suggestion has never grown
32beyond what it is now: a suggestion. Between the first draft of this
33proposal and now some communities grown faster than others. Actually it
34is obvious that we have big communities (lots of users, lots of
35translators) and smaller communities (less users, less translators). If
36we speak about localized Gentoo sites we need to find a capable
37solution for small and even bigger communities. This leads us to a
38point where the lead translator can decide between a small localized
39site including necessarily translated documents and only some
40additional pages and a bigger variant with lots of translated gdp
41documents, translated news and gwn plus additional pages.
42
43
44Rationale:
29========== 45==========
30 46
31Lots of people have shown interest in the localization proposal, 47The current layout regarding documentation in the CVS is as follows:
32and even the infrastructure team has given positive feedback. However, 48
33due to lack of a good roadmap and proposal this suggestion has never 49 [gentoo]/xml/htdocs/doc/en/*
34grown beyond what it is now: a suggestion. 50 [gentoo]/xml/htdocs/doc/nl/*
51 [gentoo]/xml/htdocs/doc/fr/*
35 52
36The current CVS structure (and permissions) are insufficient to implement a 53However, there are several other documents (about, policy, etc) in
37localized section for each possible country. The current permissions are to 54main/$lang:
38broad while they should be very strict, the current layout is too fragmented
39while it should be grouped together.
40 55
41Rationale
42=========
43
44The 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
51However, the documentation index page itself (and several other
52important parts of the Gentoo website) are structed like this::
53
54 [gentoo]/xml/htdocs/main/en/* 56 [gentoo]/xml/htdocs/main/en/*
55 [gentoo]/xml/htdocs/main/nl/* 57 [gentoo]/xml/htdocs/main/nl/*
56 [gentoo]/xml/htdocs/main/fr/* 58 [gentoo]/xml/htdocs/main/fr/*
57 ...
58 59
59This structure makes it very difficult for assigning permissions to the 60This structure makes it very difficult for assigning permissions to the
60individual translation teams, and even more difficult to really localise 61individual translation teams, and even more difficult to really localize
61the Gentoo Website. At this very moment, the translation teams can edit 62the Gentoo Website. At this very moment, the translation teams can edit
62documents of other languages or even the master English documents. English 63documents of other languages or even the master English documents. English
63reviewers and editors can touch documents of languages they possibly don't 64reviewers and editors can touch documents of languages they possibly don't
64even know. Although we do trust every single documentation editor, a better 65even know. Although we do trust every single documentation editor, a better
65implementation is advisable. 66implementation is advisable. We also can't give access to well-known
67but non-dev translators.
66 68
67We want to restructure the current layout so that the Gentoo Website is 69We want to restructure the current layout so that the Gentoo Website is
68more easily internationalized. 70more easily internationalized.
69 71
70Implementation
71==============
72 72
73CVS Structure 73Implementation:
74------------- 74===============
75 75
76What is needed, is a clear distinction between documentation, newsletters, 76Website Pages:
77website and localization. This requires a directory structure in the CVS 77--------------
78repository that reflects this distinction.
79 78
80In the following scheme, everything is relative to [gentoo]/xml/htdocs:: 79The Lead Translator can choose if he wants to maintain a "small" or a
80"big" localized site. All localized sites will be accessible on
81http://$lang.gentoo.org which will point to [gentoo]xml/htdocs/$lang.
82All localized sites must be implemented in GuideXML.
81 83
82 main/en Contains the main Gentoo Website 84Requirements for "small" localized sites:
83 main/${LANGUAGE} Contains some translated website pages 85.........................................
84 main/lcl/${COUNTRYCODE} Contains the localized Gentoo page
85 doc/en Contains the master English Documentation
86 doc/${LANGUAGE} Contains the translated Documentation
87 news/en Contains the English GWNs
88 news/${LANGUAGE} Contains the translated GWNs
89 proj/en Contains the project Webpages
90 86
91In comparison with what is currently the case, there are no big changes. 87 - all documents marked as required in our Translators Howto
92I've explicitly left out `proj/${LANGUAGE}` since there is no direct 88 - $lang/main/translators.xml, listing of all translators (including
93need to translate project websites. If it is desired, then creating a 89 GWN translators)
94language-specific directory is sufficient. 90 - $lang/main/communities.xml, listing of all community sites available in $lang
91 - index.xml "welcome page", listing of available ressources on
92 $lang.gentoo.org (i.e. links to documentation, translators.xml and
93 communities.xml)
95 94
96Website pages 95Requirements for "big" localized sites:
97------------- 96.......................................
98 97
99Currently, the main documentation page is `main/en/docs.xml`. A better 98 - all documents marked as required in our Translators Howto
100implementation would be to have it as `doc/en/index.xml`. This keeps 99 - $lang/main/translators.xml, listing of all translators (including
101everything documentation-related together. It also provides us with 100 GWN translators)
102seperate index pages for each language (`doc/${LANGUAGE}/index.xml`). 101 - $lang/main/communities.xml, listing of all community sites available in $lang
103 102 - translated $lang/main documents
104The documentation indexes should mention the other indexes (for other 103 - translated $lang/news/gwn
105languages), but shouldn't have seperate links for each language per 104 - translated news items ($lang/news) (only translated news items,
106document. 105 news items on a per-lang basis aren't allowed)
107
108The localization page resides in `main/${COUNTRYCODE}/index.xml`. This
109page, which is formatted the same way as the whole Gentoo website,
110**only** contains the following information::
111
112 - A list of community websites [1]_
113
114 - A link to the translated documentation index
115
116 - A link to translated Gentoo-webpages::
117
118 * About
119
120 * Social Contract
121
122 * Gentoo Weekly News
123
124If the localization team wants, this can be extended to also provide
125news-items (such as with the main Gentoo website). In this case, the
126news items also reside in `main/lcl/${COUNTRYCODE}`.
127
128Also, `http://${COUNTRYCODE}.gentoo.org` should point to
129`main/lcl/${COUNTRYCODE}/index.xml`.
130
131CVS Permissions
132---------------
133
134The permissions are now clear and distinct::
135
136 - Documentation Developers cannot touch the Gentoo website,
137 except for the Index page, which now resides in `doc/en`.
138
139 - Translators can only touch files in `doc/${LANGUAGE}` and
140 `main/${LANGUAGE}`.
141
142 - The localized pages, which are rather static (since they only
143 contain a list of community sites), are maintained by a
144 single group for all countrycodes, unless the localization
145 pages also contain newsitems, in which case seperate groups
146 for each country can exist.
147 106
148 107
149References 108CVS Structure:
150========== 109--------------
151 110
152.. [1] A sum of such community sites can be found at 111Actual scheme, everything is relative to [gentoo]/xml/htdocs::
153 http://dev.gentoo.org/~liquidx/communities.html
154 112
155Copyright 113 main/en Contains the main Gentoo Website (about, policy, lists, etc.)
156========= 114 main/$lang Contains some translated Website pages
115 doc/en Contains the master English Documentation
116 doc/$lang Contains the translated Documentation
117 news Contains English news items
118 news/en/gwn Contains the master English GWNs
119 news/$lang/gwn Contains translated GWNs
120 proj/en Contains the project Webpages
157 121
158This document has been placed in the public domain. 122Proposed scheme, relative to [gentoo]/xml/htdocs::
123
124 $lang/main Contains some translated Website pages
125 $lang/doc Contains the translated Documentation
126 $lang/news Contains translated news items
127 $lang/news/gwn Contains translated GWNs
128
129Mail:
130-----
131
132All mails to www-$lang@gentoo.org should be forwarded to the Lead
133Translator and his Follow-Up.
134
135
136XSL:
137----
138
139We need to "hack" our guide.xsl to support something like inserts.xml for the
140whole site.
141
142
143
144.. [#gentoo] http://www.gentoo.org
145.. [#gdp] http://gdp.gentoo.org
146

Legend:
Removed from v.1.2  
changed lines
  Added in v.1.4

  ViewVC Help
Powered by ViewVC 1.1.20