/[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.4
1<?xml version="1.0" encoding="utf-8" ?> 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"> 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"> 3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4<!-- 4
5This HTML is auto-generated. DO NOT EDIT THIS FILE! If you are writing a new
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!
8-->
9<head> 5<head>
10 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> 6 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
11 <meta name="generator" content="Docutils 0.3.7: http://docutils.sourceforge.net/" /> 7 <meta name="generator" content="Docutils 0.4: http://docutils.sourceforge.net/" />
12 <title>GLEP 51 -- Gentoo Knowledge Base</title> 8 <title>GLEP 51 -- Gentoo Knowledge Base</title>
13 <link rel="stylesheet" href="tools/glep.css" type="text/css" /> 9 <link rel="stylesheet" href="tools/glep.css" type="text/css" />
14</head> 10</head>
15<body bgcolor="white"> 11<body bgcolor="white">
16<table class="navigation" cellpadding="0" cellspacing="0" 12<table class="navigation" cellpadding="0" cellspacing="0"
20<img src="http://www.gentoo.org/images/gentoo-new.gif" alt="[Gentoo]" 16<img src="http://www.gentoo.org/images/gentoo-new.gif" alt="[Gentoo]"
21 border="0" width="150" height="35" /></a></td> 17 border="0" width="150" height="35" /></a></td>
22<td class="textlinks" align="left"> 18<td class="textlinks" align="left">
23[<b><a href="http://www.gentoo.org/">Gentoo Linux Home</a></b>] 19[<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>] 20[<b><a href="http://www.gentoo.org/proj/en/glep">GLEP Index</a></b>]
25[<b><a href="./glep-0051.txt">GLEP Source</a></b>] 21[<b><a href="http://www.gentoo.org/proj/en/glep/glep-0051.txt">GLEP Source</a></b>]
26</td></tr></table> 22</td></tr></table>
27<table class="rfc2822 docutils field-list" frame="void" rules="none"> 23<table class="rfc2822 docutils field-list" frame="void" rules="none">
28<col class="field-name" /> 24<col class="field-name" />
29<col class="field-body" /> 25<col class="field-body" />
30<tbody valign="top"> 26<tbody valign="top">
31<tr class="field"><th class="field-name">GLEP:</th><td class="field-body">51</td> 27<tr class="field"><th class="field-name">GLEP:</th><td class="field-body">51</td>
32</tr> 28</tr>
33<tr class="field"><th class="field-name">Title:</th><td class="field-body">Gentoo Knowledge Base</td> 29<tr class="field"><th class="field-name">Title:</th><td class="field-body">Gentoo Knowledge Base</td>
34</tr> 30</tr>
35<tr class="field"><th class="field-name">Version:</th><td class="field-body">0.0003</td> 31<tr class="field"><th class="field-name">Version:</th><td class="field-body">1.2</td>
36</tr> 32</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> 33<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">2007/03/26 10:27:50</a></td>
38</tr> 34</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> 35<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> 36</tr>
41<tr class="field"><th class="field-name">Status:</th><td class="field-body">Draft</td> 37<tr class="field"><th class="field-name">Status:</th><td class="field-body">Withdrawn</td>
42</tr> 38</tr>
43<tr class="field"><th class="field-name">Type:</th><td class="field-body">Standards Track</td> 39<tr class="field"><th class="field-name">Type:</th><td class="field-body">Standards Track</td>
44</tr> 40</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> 41<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> 42</tr>
47<tr class="field"><th class="field-name">Created:</th><td class="field-body">30-May-2006</td> 43<tr class="field"><th class="field-name">Created:</th><td class="field-body">30-May-2006</td>
48</tr> 44</tr>
49<tr class="field"><th class="field-name">Post-History:</th><td class="field-body">16-Aug-2006</td> 45<tr class="field"><th class="field-name">Post-History:</th><td class="field-body">26-Mar-2007</td>
50</tr> 46</tr>
51</tbody> 47</tbody>
52</table> 48</table>
53<hr /> 49<hr />
54<div class="contents topic" id="contents"> 50<div class="contents topic">
55<p class="topic-title first"><a name="contents">Contents</a></p> 51<p class="topic-title first"><a id="contents" name="contents">Contents</a></p>
56<ul class="simple"> 52<ul class="simple">
57<li><a class="reference" href="#abstract" id="id2" name="id2">Abstract</a></li> 53<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> 54<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> 55<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> 56<li><a class="reference" href="#search-functionality" id="id5" name="id5">Search functionality</a></li>
66</li> 62</li>
67<li><a class="reference" href="#frameworks" id="id10" name="id10">Frameworks</a></li> 63<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> 64<li><a class="reference" href="#copyright" id="id11" name="id11">Copyright</a></li>
69</ul> 65</ul>
70</div> 66</div>
71<div class="section" id="abstract"> 67<div class="section">
72<h1><a class="toc-backref" href="#id2" name="abstract">Abstract</a></h1> 68<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 69<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 70repository with specific solutions to specific issues and quick answers to
75common questions which aren't global enough to fit within a Gentoo Documentation 71common 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> 72Guide. Such a repository can be offered by a Gentoo Knowledge Base.</p>
77</div> 73</div>
78<div class="section" id="motivation"> 74<div class="section">
79<h1><a class="toc-backref" href="#id3" name="motivation">Motivation</a></h1> 75<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 76<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 77broadened beyond documentation and the detail level has deepend to an almost
82individual, precise answer for every question. It is no longer reasonable to 78individual, precise answer for every question. It is no longer reasonable to
83suggest that documentation is sufficient to succesfully aide users with 79suggest that documentation is sufficient to succesfully aide users with
84exploring the world of software use. Documentation is a (and perhaps even the 80exploring 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 91with precise answers to specific questions. Each topic in the repository must be
96owned by at least one knowledgeable developer, written in a structured manner 92owned by at least one knowledgeable developer, written in a structured manner
97and should leave no room for different interpretations. General topics must 93and should leave no room for different interpretations. General topics must
98provide direct links to the documentation.</p> 94provide direct links to the documentation.</p>
99</div> 95</div>
100<div class="section" id="requirements"> 96<div class="section">
101<h1><a class="toc-backref" href="#id4" name="requirements">Requirements</a></h1> 97<h1><a class="toc-backref" href="#id4" id="requirements" name="requirements">Requirements</a></h1>
102<div class="section" id="search-functionality"> 98<div class="section">
103<h2><a class="toc-backref" href="#id5" name="search-functionality">Search functionality</a></h2> 99<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 100<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 101should 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 102use. However, clear cut 'n paste queries should also prove to be very
107effective as many questions rise from error messages.</p> 103effective as many questions rise from error messages.</p>
108</div> 104</div>
109<div class="section" id="content-definition"> 105<div class="section">
110<h2><a class="toc-backref" href="#id6" name="content-definition">Content definition</a></h2> 106<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 107<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 108certain 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 109issues are specific enough (not &quot;how do I fix a build fault&quot;) they must
114describe the following aspects thoroughly:</p> 110describe the following aspects thoroughly:</p>
115<ul class="simple"> 111<ul class="simple">
128necessary steps to resolve the issue.</li> 124necessary steps to resolve the issue.</li>
129</ul> 125</ul>
130<p>A second type of queries would be small (but interesting) FAQs. These answers 126<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> 127are 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 128<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 129to this. However, we do not add topics that are specific to non-Gentoo
134distributions.</p> 130distributions.</p>
135</div> 131</div>
136<div class="section" id="feedback-system"> 132<div class="section">
137<h2><a class="toc-backref" href="#id7" name="feedback-system">Feedback system</a></h2> 133<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 134<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 135answer 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> 136&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 137<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 138information to the topic, allowing the maintainer of the topic to update it
143with more accurate information.</p> 139with more accurate information.</p>
144</div> 140</div>
145<div class="section" id="topic-maintenance-system"> 141<div class="section">
146<h2><a class="toc-backref" href="#id8" name="topic-maintenance-system">Topic maintenance system</a></h2> 142<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 143<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 144allow the developer to watch his topics and update them when needed. Of
149course, topics related to specific herds should be maintainable by the team 145course, topics related to specific herds should be maintainable by the team
150responsible for the herd.</p> 146responsible for the herd.</p>
151<p>Although not required, revision history would be great :-)</p> 147<p>Although not required, revision history would be great :-)</p>
152</div> 148</div>
153<div class="section" id="license"> 149<div class="section">
154<h2><a class="toc-backref" href="#id9" name="license">License</a></h2> 150<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 151<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 152enough to warrant a different license shouldn't be in the knowledge base
157anyway.</p> 153anyway.</p>
158</div> 154</div>
159</div> 155</div>
160<div class="section" id="frameworks"> 156<div class="section">
161<h1><a class="toc-backref" href="#id10" name="frameworks">Frameworks</a></h1> 157<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 158<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 159of 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 160that adheres to the requirements, the knowledge base project should build one
165up until the requirements are met.</p> 161up until the requirements are met.</p>
166<p>We currently do not have any technical requirements on the frameworks, but at 162<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 163the end the knowledge base should be hosted on official Gentoo hardware and
168maintained by the Infrastructure project. As such, the Infrastructure project 164maintained by the Infrastructure project. As such, the Infrastructure project
169has final saying on the frameworks used in the knowledge base.</p> 165has final saying on the frameworks used in the knowledge base.</p>
170</div> 166</div>
171<div class="section" id="copyright"> 167<div class="section">
172<h1><a class="toc-backref" href="#id11" name="copyright">Copyright</a></h1> 168<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> 169<p>This document has been placed in the public domain.</p>
174</div> 170</div>
175 171
176</div> 172</div>
177<hr class="docutils footer" />
178<div class="footer"> 173<div class="footer">
174<hr class="footer" />
179<a class="reference" href="glep-0051.txt">View document source</a>. 175<a class="reference" href="glep-0051.txt">View document source</a>.
180Generated on: 2006-08-16 19:24 UTC. 176Generated on: 2007-10-13 13:39 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. 177Generated 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.
178
182</div> 179</div>
183</body> 180</body>
184</html> 181</html>
185 182

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

  ViewVC Help
Powered by ViewVC 1.1.20