os/doc
3
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Updated to reflect reality;

Browse source 
* List myself as co-ordinating the "Rewrite the Handbook" section

  * Fixed a bunch of markup 'errors'

  * Add a "Search engine enhancement" request from docs/10088

  * Put ">" after most of the e-mail addresses, to match the opening
    "<" that they have.

Some of it is from

PR:             docs/10088
Submitted by:   Bob Flavin <ribo@watson.ibm.com>
This commit is contained in:
Nik Clayton 1999-06-04 22:52:21 +00:00
parent a27ba92abc
commit ec49d517f0
Notes: svn2git 2020-12-08 03:00:23 +00:00 
svn path=/www/; revision=5021
1 changed files with 46 additions and 50 deletions
Download patch file Download diff file Expand all files Collapse all files

96
en/docproj/current.sgml
View file

@ -1,10 +1,10 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2//EN" [
<!ENTITY base CDATA "..">
<!ENTITY date "$Date: 1999-04-26 21:47:42 $">
<!ENTITY date "$Date: 1999-06-04 22:52:21 $">
<!ENTITY title "FreeBSD Documentation Project: Current projects">
<!ENTITY % includes SYSTEM "../includes.sgml"> %includes;
]>
<!-- $Id: current.sgml,v 1.11 1999-04-26 21:47:42 nik Exp $ -->
<!-- $Id: current.sgml,v 1.12 1999-06-04 22:52:21 nik Exp $ -->
<html>
&header;
@ -36,6 +36,7 @@
<li><a href="#cgiscripts">CGI Scripts</a></li>
<li><a href="#multilingualwebscripts">Multilingual Web scripts</a></li>
<li><a href="#translations">Translations of the FreeBSD Documentation</a></li>
<li><a href="#search-enhancements">Search engine enhancements</a></li>
</ul>
@ -47,7 +48,7 @@
You can <a
href="http://www.freebsd.org/cgi/query-pr-summary.cgi?category=docs&amp;responsible=.">view</a>
the open documenation problem reports.
the open documenation problem reports.</p>
<a name="freebsd4linux"></a>
<h3><font color="#660000">FreeBSD for Linux users</font></h3>
@ -90,60 +91,45 @@
<a name="rewritethehandbook"></a>
<h3><font color="#660000">Rewrite the Handbook :-)</font></h3>
<p><b>Responsible:</b> No one, yet</p>
<p><b>Responsible:</b> Nik Clayton &lt<a href="nik@freebsd.org">nik@freebsd.org</a>&gt;</p>
<p><b>Synopsis:</b> The Handbook has grown quite organically over the
past few years. This means some of the sections are not organised as
well as they could be, and some of it needs reworking.</p>
<p>Someone needs to</p>
<ul>
<li>Read the Handbook thoroughly</li>
<li>Come up with a revised structure for it</li>
<li>Understand how the Handbook is implemented (this will
mean learning some stuff about SGML, and probably
liasing with the DocBook migration project)</li>
<li>Actually do the rework.</li>
</ul>
<p>To break this into manageable chunks, it would be really handy
if someone could first maintain a web page that lists people's
current comments about the Handbook structure. That would at
least give us all something to work from.</p>
<p>If no one steps forward to handle this I am going to do
it. It will just take me a while to get to it (since I need to
get the DocBook migration out of the way first).</p>
<p>Currently, a reasonable plan to accomplish this has been drawn up,
and it's currently waiting for some other, higher priority, projects to
be finished first. Contact Nik (preferably through the &lt;<a
href="doc@freebsd.org">doc@freebsd.org</a>&gt; mailing list) for more
detailed information.</p>
<a name="newpapers"></a>
<h3><font color="#660000">Write some new Papers</font></h3>
<h4><font color="#660000">The FreeBSD VM architecture</font></h4>
<p><b>Responsible:</b> John Dyson &lt;<a href="mailto:dyson@iquest.net">
dyson@iquest.net</a></p>
<p><b>Responsible:</b> John Dyson &lt;<a href="mailto:dyson@iquest.net">dyson@iquest.net</a>&gt;</p>
<p><b>Synopsis:</b> FreeBSD 2.x has a completly rewritten
virtual memory
architecture. Unfortunately there is no documentation available
about the FreeBSD VM architecture execpt the source code and
some old E-Mails from John Dyson.
See <a href="http://www.backplane.com/FreeBSD/FreeBSDVM.txt">
FreeBSD VM System Overview</a> for a first snapshot.
FreeBSD VM System Overview</a> for a first snapshot.</p>
<h4><font color="#660000">The New SCSI layer for FreeBSD (CAM)</font></h4>
<p><b>Responsible:</b>
&lt;<a href="mailto:doc@freebsd.org">doc@freebsd.org</a>>,
&lt;<a href="mailto:scsi@freebsd.org">scsi@freebsd.org</a>>
&lt;<a href="mailto:doc@freebsd.org">doc@freebsd.org</a>&gt;,
&lt;<a href="mailto:scsi@freebsd.org">scsi@freebsd.org</a>&gt;</p>
<p><b>Synopsis:</b> See <a href="http://www.freebsd.org/~gibbs/">
The Design and Implementation of the FreeBSD SCSI Subsystem</a>
for a first snapshot.
for a first snapshot.</p>
<a name="newtutorials"></a>
<h3><font color="#660000">Write some new Tutorials</font></h3>
<p><b>Responsible:</b>
&lt;<a href="mailto:doc@freebsd.org">doc@freebsd.org</a>
&lt;<a href="mailto:doc@freebsd.org">doc@freebsd.org</a>&gt;
<p><b>Synopsis:</b>
<p><b>Synopsis:</b></p>
<ul>
<li>How to update from a.out to elf</li>
<li>How to build a FreeBSD release</li>
@ -152,21 +138,20 @@
<a name="newkernelmanpages"></a>
<h3><font color="#660000">Write Manpages for the kernel</font></h3>
<p><b>Responsible:</b>
&lt;<a href="mailto:doc@freebsd.org">doc@freebsd.org</a>
<p><b>Synopsis:</b> Document kernel functions, section 9
&lt;<a href="mailto:doc@freebsd.org">doc@freebsd.org</a>&gt;
<p><b>Synopsis:</b> Document kernel functions, section 9</p>
<a name="cgiscripts"></a>
<h3><font color="#660000">CGI Scripts</font></h3>
<p><b>Responsible:</b>
&lt;<a href="mailto:doc@freebsd.org">doc@freebsd.org</a>,
Wolfram Schneider &lt;<a href="mailto:wosch@freebsd.org">
wosch@freebsd.org</a>
<p><b>Synopsis:</b>
Wolfram Schneider &lt;<a href="mailto:wosch@freebsd.org">wosch@freebsd.org</a>&gt;</p>
<p><b>Synopsis:</b></p>
<ul>
<li>Rewrite cvsweb.cgi cgi script from scratch using a
RCS perl Module</li>
<li>Rewrite man.cgi cgi script and fix some bugs.</li>
<li>Write a ports INDEX perl Module.
<li>Write a ports INDEX perl Module.</li>
</ul>
<h3>Here are some hints how to write the ports module</h3>
@ -206,20 +191,20 @@ $port = {
<h4>Now we need some functions</h4>
<ul>
<li>Print a $port object as HTML output
<li>Print a $port object as ASCII output
<li>Find all objects which are maintained by user XYZ
<li>Find all objects which are in category XYZ
<li>Find all objects which run/build depend on port XYZ
<li>Print a $port object as HTML output</li>
<li>Print a $port object as ASCII output</li>
<li>Find all objects which are maintained by user XYZ</li>
<li>Find all objects which are in category XYZ</li>
<li>Find all objects which run/build depend on port XYZ</li>
<li>Find all objects which match the string XYZ in DISTRIBUTION_NAME
or COMMENT
<li>Sort objects by DISTRIBUTION_NAME
or COMMENT</li>
<li>Sort objects by DISTRIBUTION_NAME</li>
</ul>
<h4>Finally</h4>
<p>Modify the cgi script url.cgi, ports.cgi , pds.cgi and the
script portindex to use this module.
script portindex to use this module.</p>
<p><b>Contact</b> Nik Clayton &lt;<a
href="mailto:nik@FreeBSD.ORG">nik@FreeBSD.ORG</a>&gt; for a
@ -230,14 +215,15 @@ $port = {
<h3><font color="#660000">Multilingual Web scripts</font></h3>
<p><b>Responsible:</b>
&lt;<a href="mailto:doc@freebsd.org">doc@freebsd.org</a>>
&lt;<a href="mailto:doc@freebsd.org">doc@freebsd.org</a>&gt;</p>
<p></p>
<p><b>Synopsis:</b>
<p><b>Synopsis:</b></p>
<p>
Our main Web pages are written in (American) English. The <a
href="translations.html">FreeBSD Translations Projects</a>
translate the web pages, Handbook and FAQ to other languages.
translate the web pages, Handbook and FAQ to other languages.</p>
<p>
We must translate the cgi scripts and web build scripts too. The
@ -257,12 +243,22 @@ $port = {
<a name="translations"></a>
<h3><font color="#660000">Translations of the FreeBSD Documentation</font></h3>
<p><b>Responsible:</b>
&lt;<a href="mailto:doc@freebsd.org">doc@freebsd.org</a>
&lt;<a href="mailto:doc@freebsd.org">doc@freebsd.org</a>&gt;
Translate the FreeBSD documentation (Web pages, FAQ,
handbook, manpages) into other languages. See the
<a href="translations.html">FreeBSD translations projects</a>
<a href="translations.html">FreeBSD translations projects</a></p>
<a name="search-enhancements"></a>
<h3><font color="#660000">Search engine enhancements</font></h3>
<p><b>Responsible:</b> &lt;<a href="mailto:doc@freebsd.org">doc@freebsd.org</a>&gt;</p>
<p>When searching the website, the output from the search engine includes
the filename that was found, which might be something like
<tt>FAQ34.html</tt>.</p>
<p>It would be more useful if the results included the question text,
allowing the user to see whether or now the result was relevant.</p>
<p></p><a href="docproj.html">FreeBSD Documentation Project Home</a>
&footer