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

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

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

Revision 1.1 Revision 1.2
6PEP, see http://www.python.org/peps/pep-0001.html for instructions and links 6PEP, see http://www.python.org/peps/pep-0001.html for instructions and links
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.7: http://docutils.sourceforge.net/" /> 11 <meta name="generator" content="Docutils 0.4: http://docutils.sourceforge.net/" />
12 <title>GLEP 51 -- Gentoo Knowledge Base</title> 12 <title>GLEP 51 -- Gentoo Knowledge Base</title>
13 <link rel="stylesheet" href="tools/glep.css" type="text/css" /> 13 <style type="text/css">
14
15/*
16:Author: David Goodger
17:Contact: goodger@users.sourceforge.net
18:date: $Date: 2006/10/10 20:25:14 $
19:version: $Revision: 1.2 $
20:copyright: This stylesheet has been placed in the public domain.
21
22Default cascading style sheet for the PEP HTML output of Docutils.
23*/
24
25.first {
26 margin-top: 0 }
27
28.last {
29 margin-bottom: 0 }
30
31.navigation {
32 width: 100% ;
33 background: #cc99ff ;
34 margin-top: 0px ;
35 margin-bottom: 0px }
36
37.navigation .navicon {
38 width: 150px ;
39 height: 35px }
40
41.navigation .textlinks {
42 padding-left: 1em ;
43 text-align: left }
44
45.navigation td, .navigation th {
46 padding-left: 0em ;
47 padding-right: 0em ;
48 vertical-align: middle }
49
50.rfc2822 {
51 margin-top: 0.5em ;
52 margin-left: 0.5em ;
53 margin-right: 0.5em ;
54 margin-bottom: 0em }
55
56.rfc2822 td {
57 text-align: left }
58
59.rfc2822 th.field-name {
60 text-align: right ;
61 font-family: sans-serif ;
62 padding-right: 0.5em ;
63 font-weight: bold ;
64 margin-bottom: 0em }
65
66a.toc-backref {
67 text-decoration: none ;
68 color: black }
69
70body {
71 margin: 0px ;
72 margin-bottom: 1em ;
73 padding: 0px }
74
75dd {
76 margin-bottom: 0.5em }
77
78div.section {
79 margin-left: 1em ;
80 margin-right: 1em ;
81 margin-bottom: 1.5em }
82
83div.section div.section {
84 margin-left: 0em ;
85 margin-right: 0em ;
86 margin-top: 1.5em }
87
88div.abstract {
89 margin: 2em 5em }
90
91div.abstract p.topic-title {
92 font-weight: bold ;
93 text-align: center }
94
95div.attention, div.caution, div.danger, div.error, div.hint,
96div.important, div.note, div.tip, div.warning {
97 margin: 2em ;
98 border: medium outset ;
99 padding: 1em }
100
101div.attention p.admonition-title, div.caution p.admonition-title,
102div.danger p.admonition-title, div.error p.admonition-title,
103div.warning p.admonition-title {
104 color: red ;
105 font-weight: bold ;
106 font-family: sans-serif }
107
108div.hint p.admonition-title, div.important p.admonition-title,
109div.note p.admonition-title, div.tip p.admonition-title {
110 font-weight: bold ;
111 font-family: sans-serif }
112
113div.figure {
114 margin-left: 2em }
115
116div.footer, div.header {
117 font-size: smaller }
118
119div.footer {
120 margin-left: 1em ;
121 margin-right: 1em }
122
123div.system-messages {
124 margin: 5em }
125
126div.system-messages h1 {
127 color: red }
128
129div.system-message {
130 border: medium outset ;
131 padding: 1em }
132
133div.system-message p.system-message-title {
134 color: red ;
135 font-weight: bold }
136
137div.topic {
138 margin: 2em }
139
140h1 {
141 font-family: sans-serif ;
142 font-size: large }
143
144h2 {
145 font-family: sans-serif ;
146 font-size: medium }
147
148h3 {
149 font-family: sans-serif ;
150 font-size: small }
151
152h4 {
153 font-family: sans-serif ;
154 font-style: italic ;
155 font-size: small }
156
157h5 {
158 font-family: sans-serif;
159 font-size: x-small }
160
161h6 {
162 font-family: sans-serif;
163 font-style: italic ;
164 font-size: x-small }
165
166.section hr {
167 width: 75% }
168
169ol.simple, ul.simple {
170 margin-bottom: 1em }
171
172ol.arabic {
173 list-style: decimal }
174
175ol.loweralpha {
176 list-style: lower-alpha }
177
178ol.upperalpha {
179 list-style: upper-alpha }
180
181ol.lowerroman {
182 list-style: lower-roman }
183
184ol.upperroman {
185 list-style: upper-roman }
186
187p.caption {
188 font-style: italic }
189
190p.credits {
191 font-style: italic ;
192 font-size: smaller }
193
194p.label {
195 white-space: nowrap }
196
197p.topic-title {
198 font-family: sans-serif ;
199 font-weight: bold }
200
201pre.line-block {
202 font-family: serif ;
203 font-size: 100% }
204
205pre.literal-block, pre.doctest-block {
206 margin-left: 2em ;
207 margin-right: 2em ;
208 background-color: #eeeeee }
209
210span.classifier {
211 font-family: sans-serif ;
212 font-style: oblique }
213
214span.classifier-delimiter {
215 font-family: sans-serif ;
216 font-weight: bold }
217
218span.interpreted {
219 font-family: sans-serif }
220
221span.option-argument {
222 font-style: italic }
223
224span.pre {
225 white-space: pre }
226
227span.problematic {
228 color: red }
229
230table {
231 margin-top: 0.5em ;
232 margin-bottom: 0.5em }
233
234td, th {
235 padding-left: 0.5em ;
236 padding-right: 0.5em ;
237 vertical-align: top }
238
239td.num {
240 text-align: right }
241
242th.field-name {
243 font-weight: bold ;
244 text-align: left ;
245 white-space: nowrap }
246
247h1 tt, h2 tt, h3 tt, h4 tt, h5 tt, h6 tt {
248 font-size: 100% }
249
250tt {
251 background-color: #eeeeee }
252
253ul.auto-toc {
254 list-style-type: none }
255
256</style>
14</head> 257</head>
15<body bgcolor="white"> 258<body bgcolor="white">
16<table class="navigation" cellpadding="0" cellspacing="0" 259<table class="navigation" cellpadding="0" cellspacing="0"
17 width="100%" border="0"> 260 width="100%" border="0">
18<tr><td class="navicon" width="150" height="35"> 261<tr><td class="navicon" width="150" height="35">
19<a href="http://www.gentoo.org/" title="Gentoo Linux Home Page"> 262<a href="http://www.gentoo.org/" title="Gentoo Linux Home Page">
20<img src="http://www.gentoo.org/images/gentoo-new.gif" alt="[Gentoo]" 263<img src="http://www.gentoo.org/images/gentoo-new.gif" alt="[Gentoo]"
21 border="0" width="150" height="35" /></a></td> 264 border="0" width="150" height="35" /></a></td>
22<td class="textlinks" align="left"> 265<td class="textlinks" align="left">
23[<b><a href="http://www.gentoo.org/">Gentoo Linux Home</a></b>] 266[<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>] 267[<b><a href="http://www.gentoo.org/peps">GLEP Index</a></b>]
25[<b><a href="./glep-0051.txt">GLEP Source</a></b>] 268[<b><a href="http://www.gentoo.org/proj/en/glep/glep-0051.txt">GLEP Source</a></b>]
26</td></tr></table> 269</td></tr></table>
27<table class="rfc2822 docutils field-list" frame="void" rules="none"> 270<table class="rfc2822 docutils field-list" frame="void" rules="none">
28<col class="field-name" /> 271<col class="field-name" />
29<col class="field-body" /> 272<col class="field-body" />
30<tbody valign="top"> 273<tbody valign="top">
31<tr class="field"><th class="field-name">GLEP:</th><td class="field-body">51</td> 274<tr class="field"><th class="field-name">GLEP:</th><td class="field-body">51</td>
32</tr> 275</tr>
33<tr class="field"><th class="field-name">Title:</th><td class="field-body">Gentoo Knowledge Base</td> 276<tr class="field"><th class="field-name">Title:</th><td class="field-body">Gentoo Knowledge Base</td>
34</tr> 277</tr>
35<tr class="field"><th class="field-name">Version:</th><td class="field-body">0.0003</td> 278<tr class="field"><th class="field-name">Version:</th><td class="field-body">1.1</td>
36</tr> 279</tr>
37<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/xml/htdocs/proj/en/glep/glep-0051.txt?cvsroot=gentoo">2006/06/15 19:32:36</a></td> 280<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-0051.txt?cvsroot=gentoo">2006/08/16 19:25:14</a></td>
38</tr> 281</tr>
39<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> 282<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> 283</tr>
41<tr class="field"><th class="field-name">Status:</th><td class="field-body">Draft</td> 284<tr class="field"><th class="field-name">Status:</th><td class="field-body">Draft</td>
42</tr> 285</tr>
43<tr class="field"><th class="field-name">Type:</th><td class="field-body">Standards Track</td> 286<tr class="field"><th class="field-name">Type:</th><td class="field-body">Standards Track</td>
44</tr> 287</tr>
45<tr class="field"><th class="field-name">Content-Type:</th><td class="field-body"><a class="reference" href="glep-0012.html">text/x-rst</a></td> 288<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>
46</tr> 289</tr>
47<tr class="field"><th class="field-name">Created:</th><td class="field-body">30-May-2006</td> 290<tr class="field"><th class="field-name">Created:</th><td class="field-body">30-May-2006</td>
48</tr> 291</tr>
49<tr class="field"><th class="field-name">Post-History:</th><td class="field-body">16-Aug-2006</td> 292<tr class="field"><th class="field-name">Post-History:</th><td class="field-body">16-Aug-2006</td>
50</tr> 293</tr>
51</tbody> 294</tbody>
52</table> 295</table>
53<hr /> 296<hr />
54<div class="contents topic" id="contents"> 297<div class="contents topic">
55<p class="topic-title first"><a name="contents">Contents</a></p> 298<p class="topic-title first"><a id="contents" name="contents">Contents</a></p>
56<ul class="simple"> 299<ul class="simple">
57<li><a class="reference" href="#abstract" id="id2" name="id2">Abstract</a></li> 300<li><a class="reference" href="#abstract" id="id2" name="id2">Abstract</a></li>
58<li><a class="reference" href="#motivation" id="id3" name="id3">Motivation</a></li> 301<li><a class="reference" href="#motivation" id="id3" name="id3">Motivation</a></li>
59<li><a class="reference" href="#requirements" id="id4" name="id4">Requirements</a><ul> 302<li><a class="reference" href="#requirements" id="id4" name="id4">Requirements</a><ul>
60<li><a class="reference" href="#search-functionality" id="id5" name="id5">Search functionality</a></li> 303<li><a class="reference" href="#search-functionality" id="id5" name="id5">Search functionality</a></li>
66</li> 309</li>
67<li><a class="reference" href="#frameworks" id="id10" name="id10">Frameworks</a></li> 310<li><a class="reference" href="#frameworks" id="id10" name="id10">Frameworks</a></li>
68<li><a class="reference" href="#copyright" id="id11" name="id11">Copyright</a></li> 311<li><a class="reference" href="#copyright" id="id11" name="id11">Copyright</a></li>
69</ul> 312</ul>
70</div> 313</div>
71<div class="section" id="abstract"> 314<div class="section">
72<h1><a class="toc-backref" href="#id2" name="abstract">Abstract</a></h1> 315<h1><a class="toc-backref" href="#id2" id="abstract" name="abstract">Abstract</a></h1>
73<p>To improve the self-healing abilities of the Gentoo users, we have to offer a 316<p>To improve the self-healing abilities of the Gentoo users, we have to offer a
74repository with specific solutions to specific issues and quick answers to 317repository with specific solutions to specific issues and quick answers to
75common questions which aren't global enough to fit within a Gentoo Documentation 318common questions which aren't global enough to fit within a Gentoo Documentation
76Guide. Such a repository can be offered by a Gentoo Knowledge Base.</p> 319Guide. Such a repository can be offered by a Gentoo Knowledge Base.</p>
77</div> 320</div>
78<div class="section" id="motivation"> 321<div class="section">
79<h1><a class="toc-backref" href="#id3" name="motivation">Motivation</a></h1> 322<h1><a class="toc-backref" href="#id3" id="motivation" name="motivation">Motivation</a></h1>
80<p>When we look at the software projects today, we find that information has 323<p>When we look at the software projects today, we find that information has
81broadened beyond documentation and the detail level has deepend to an almost 324broadened beyond documentation and the detail level has deepend to an almost
82individual, precise answer for every question. It is no longer reasonable to 325individual, precise answer for every question. It is no longer reasonable to
83suggest that documentation is sufficient to succesfully aide users with 326suggest that documentation is sufficient to succesfully aide users with
84exploring the world of software use. Documentation is a (and perhaps even the 327exploring the world of software use. Documentation is a (and perhaps even the
95with precise answers to specific questions. Each topic in the repository must be 338with precise answers to specific questions. Each topic in the repository must be
96owned by at least one knowledgeable developer, written in a structured manner 339owned by at least one knowledgeable developer, written in a structured manner
97and should leave no room for different interpretations. General topics must 340and should leave no room for different interpretations. General topics must
98provide direct links to the documentation.</p> 341provide direct links to the documentation.</p>
99</div> 342</div>
100<div class="section" id="requirements"> 343<div class="section">
101<h1><a class="toc-backref" href="#id4" name="requirements">Requirements</a></h1> 344<h1><a class="toc-backref" href="#id4" id="requirements" name="requirements">Requirements</a></h1>
102<div class="section" id="search-functionality"> 345<div class="section">
103<h2><a class="toc-backref" href="#id5" name="search-functionality">Search functionality</a></h2> 346<h2><a class="toc-backref" href="#id5" id="search-functionality" name="search-functionality">Search functionality</a></h2>
104<p>As one of the major features of a good Knowledge Base, the search engine used 347<p>As one of the major features of a good Knowledge Base, the search engine used
105should allow for natural language queries as those are easier for people to 348should allow for natural language queries as those are easier for people to
106use. However, clear cut 'n paste queries should also prove to be very 349use. However, clear cut 'n paste queries should also prove to be very
107effective as many questions rise from error messages.</p> 350effective as many questions rise from error messages.</p>
108</div> 351</div>
109<div class="section" id="content-definition"> 352<div class="section">
110<h2><a class="toc-backref" href="#id6" name="content-definition">Content definition</a></h2> 353<h2><a class="toc-backref" href="#id6" id="content-definition" name="content-definition">Content definition</a></h2>
111<p>The topics with the most content would be the issue-type topics who describe a 354<p>The topics with the most content would be the issue-type topics who describe a
112certain error and inform the user about the resolution. To make sure these 355certain error and inform the user about the resolution. To make sure these
113issues are specific enough (not &quot;how do I fix a build fault&quot;) they must 356issues are specific enough (not &quot;how do I fix a build fault&quot;) they must
114describe the following aspects thoroughly:</p> 357describe the following aspects thoroughly:</p>
115<ul class="simple"> 358<ul class="simple">
128necessary steps to resolve the issue.</li> 371necessary steps to resolve the issue.</li>
129</ul> 372</ul>
130<p>A second type of queries would be small (but interesting) FAQs. These answers 373<p>A second type of queries would be small (but interesting) FAQs. These answers
131are short and precise, most of the time one or two paragraphs.</p> 374are short and precise, most of the time one or two paragraphs.</p>
132<p>Although several topics will be Gentoo specific, we will not limit ourselves 375<p>Although several topics will be Gentoo specific, we will not limit ourselves
133to this. However, we do not add topics that are specific to non-Gentoo 376to this. However, we do not add topics that are specific to non-Gentoo
134distributions.</p> 377distributions.</p>
135</div> 378</div>
136<div class="section" id="feedback-system"> 379<div class="section">
137<h2><a class="toc-backref" href="#id7" name="feedback-system">Feedback system</a></h2> 380<h2><a class="toc-backref" href="#id7" id="feedback-system" name="feedback-system">Feedback system</a></h2>
138<p>The knowledge base should allow for user feedback. Feedback such as &quot;Does this 381<p>The knowledge base should allow for user feedback. Feedback such as &quot;Does this
139answer your question?&quot; is invaluable to improve the search results whereas 382answer your question?&quot; is invaluable to improve the search results whereas
140&quot;Mark this topic as outdated&quot; helps us keep the knowledge base in good shape.</p> 383&quot;Mark this topic as outdated&quot; helps us keep the knowledge base in good shape.</p>
141<p>We might want to consider allowing user comments too: they can add priceless 384<p>We might want to consider allowing user comments too: they can add priceless
142information to the topic, allowing the maintainer of the topic to update it 385information to the topic, allowing the maintainer of the topic to update it
143with more accurate information.</p> 386with more accurate information.</p>
144</div> 387</div>
145<div class="section" id="topic-maintenance-system"> 388<div class="section">
146<h2><a class="toc-backref" href="#id8" name="topic-maintenance-system">Topic maintenance system</a></h2> 389<h2><a class="toc-backref" href="#id8" id="topic-maintenance-system" name="topic-maintenance-system">Topic maintenance system</a></h2>
147<p>Each topic should be maintained by a knowledgeable developer. The system must 390<p>Each topic should be maintained by a knowledgeable developer. The system must
148allow the developer to watch his topics and update them when needed. Of 391allow the developer to watch his topics and update them when needed. Of
149course, topics related to specific herds should be maintainable by the team 392course, topics related to specific herds should be maintainable by the team
150responsible for the herd.</p> 393responsible for the herd.</p>
151<p>Although not required, revision history would be great :-)</p> 394<p>Although not required, revision history would be great :-)</p>
152</div> 395</div>
153<div class="section" id="license"> 396<div class="section">
154<h2><a class="toc-backref" href="#id9" name="license">License</a></h2> 397<h2><a class="toc-backref" href="#id9" id="license" name="license">License</a></h2>
155<p>The content of the knowledge base should be public domain. Everything large 398<p>The content of the knowledge base should be public domain. Everything large
156enough to warrant a different license shouldn't be in the knowledge base 399enough to warrant a different license shouldn't be in the knowledge base
157anyway.</p> 400anyway.</p>
158</div> 401</div>
159</div> 402</div>
160<div class="section" id="frameworks"> 403<div class="section">
161<h1><a class="toc-backref" href="#id10" name="frameworks">Frameworks</a></h1> 404<h1><a class="toc-backref" href="#id10" id="frameworks" name="frameworks">Frameworks</a></h1>
162<p>Based on the requirements, one or more frameworks will be chosen. These should 405<p>Based on the requirements, one or more frameworks will be chosen. These should
163of course be free software projects; if we can't find any set of frameworks 406of course be free software projects; if we can't find any set of frameworks
164that adheres to the requirements, the knowledge base project should build one 407that adheres to the requirements, the knowledge base project should build one
165up until the requirements are met.</p> 408up until the requirements are met.</p>
166<p>We currently do not have any technical requirements on the frameworks, but at 409<p>We currently do not have any technical requirements on the frameworks, but at
167the end the knowledge base should be hosted on official Gentoo hardware and 410the end the knowledge base should be hosted on official Gentoo hardware and
168maintained by the Infrastructure project. As such, the Infrastructure project 411maintained by the Infrastructure project. As such, the Infrastructure project
169has final saying on the frameworks used in the knowledge base.</p> 412has final saying on the frameworks used in the knowledge base.</p>
170</div> 413</div>
171<div class="section" id="copyright"> 414<div class="section">
172<h1><a class="toc-backref" href="#id11" name="copyright">Copyright</a></h1> 415<h1><a class="toc-backref" href="#id11" id="copyright" name="copyright">Copyright</a></h1>
173<p>This document has been placed in the public domain.</p> 416<p>This document has been placed in the public domain.</p>
174</div> 417</div>
175 418
176</div> 419</div>
177<hr class="docutils footer" />
178<div class="footer"> 420<div class="footer">
421<hr class="footer" />
179<a class="reference" href="glep-0051.txt">View document source</a>. 422<a class="reference" href="glep-0051.txt">View document source</a>.
180Generated on: 2006-08-16 19:24 UTC. 423Generated on: 2006-10-10 20:23 UTC.
181Generated 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. 424Generated 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.
425
182</div> 426</div>
183</body> 427</body>
184</html> 428</html>
185 429

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

  ViewVC Help
Powered by ViewVC 1.1.20