From 7ad976be0a9f54863f7312118a2321749c4879e4 Mon Sep 17 00:00:00 2001 From: Eitan Adler Date: Wed, 26 Jun 2013 19:43:19 +0000 Subject: [PATCH] point users to the actual up-to-date ideas page/todo list. The one the webpage has been wrong for months (years?) and all the still relevent ideas have been migrated. Discussed on: -doc --- en_US.ISO8859-1/htdocs/docproj/Makefile | 1 - en_US.ISO8859-1/htdocs/docproj/current.xml | 7 +- en_US.ISO8859-1/htdocs/docproj/todo.xml | 383 --------------------- 3 files changed, 3 insertions(+), 388 deletions(-) delete mode 100644 en_US.ISO8859-1/htdocs/docproj/todo.xml diff --git a/en_US.ISO8859-1/htdocs/docproj/Makefile b/en_US.ISO8859-1/htdocs/docproj/Makefile index 7ee2767c64..20efd4430d 100644 --- a/en_US.ISO8859-1/htdocs/docproj/Makefile +++ b/en_US.ISO8859-1/htdocs/docproj/Makefile @@ -15,7 +15,6 @@ DOCS+= submitting.xml DOCS+= who.xml DOCS+= translations.xml DOCS+= docproj.xml -DOCS+= todo.xml INDEXLINK= docproj.html diff --git a/en_US.ISO8859-1/htdocs/docproj/current.xml b/en_US.ISO8859-1/htdocs/docproj/current.xml index 300cbf877c..8b7c4daa78 100644 --- a/en_US.ISO8859-1/htdocs/docproj/current.xml +++ b/en_US.ISO8859-1/htdocs/docproj/current.xml @@ -50,11 +50,10 @@

Documentation TODO list

-

The Documentation TODO list is an +

The Documentation TODO + list is an up-to-date list of documentation issues that should be resolved. - This list is posted every month on the FreeBSD-doc@FreeBSD.org - mailing list. If you wish to help us to improve the FreeBSD + If you wish to help us to improve the FreeBSD documentation set you should, at first, choose to work on one of the TODO list items.

diff --git a/en_US.ISO8859-1/htdocs/docproj/todo.xml b/en_US.ISO8859-1/htdocs/docproj/todo.xml deleted file mode 100644 index 59881baba5..0000000000 --- a/en_US.ISO8859-1/htdocs/docproj/todo.xml +++ /dev/null @@ -1,383 +0,0 @@ - - - - -N/A"> -Done"> -In progress"> -Needs testing"> -Not done"> -Unknown"> -Deferred for future release"> - - - - -]> - - - - - - &title; - - $FreeBSD$ - - - - -

This is a list of documentation issues that need to be resolved. - If you have any updates for this list, please e-mail - doceng@FreeBSD.org.

- - - - -

Handbook Items

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
IssueStatusResponsibleDesired DeadlineDescription
Installation chapter needs to be updated&status.new;&a.keramida; The installation chapter mostly covers FreeBSD 4.X - installation. The current information is often outdated and not - accurate for 5.X, 6.X and 7.X. We also have to think about - installation on various platforms. This should be done under - re@ team responsability since the installation notes have to be - updated as well.
Printing chapter lacks a quick and easy setup example&status.new;  While this chapter covers in a very accurate way the - configuration of a printer under FreeBSD, a quick and easy printer - setup should be documented, i.e., something describing the - installation and use of apsfilter or equivalent.
USB printers&status.new;  Nowadays printers use the USB interface, the printing chapter - may need to be updated on this point.
Wireless&status.new;&a.murray;, &a.blackend; The merge of this article - in the current wireless section should be done quickly.
IPsec section&status.new;  This section still shows the use of gifconfig(4) which is 4.X - only.
USB audio&status.new;  One should check if we need to update the sound section for - USB devices or if the current guidances are still correct with - these devices.
The Emergency Restore Procedure section (16.12.8)&status.new;  This section is really outdated and needs a serious - "facelifting." We must show how to restore a system using the - livefs from disc1. The rescue system should also be - covered.
Backup Basics (16.12)&status.new;&a.murray; Backing up on optical media (CD/DVD) should be presented.
Electronic mail chapter&status.new;&a.jcamou; The use of Makefile facilities should be introduced for the - sendmail configuration instead of the old outdated way.
inetd&status.done;&a.ceri;For 6.1-RELEASEThe configuration of inetd changed a bit in 6.X, one should - check if the related section is still correct.
bsnmpd&status.new;  The bsnmpd daemon is quite new and its configuration may be - complex. The minimal common settings should be introduced in a - section of the Network Servers chapter.
The handbook needs to be updated to match 5.X and beyond&status.done;&a.trhodes; The handbook covers a lot of 4.X material and has 5.X - information on the background. The handbook should be - updated to remove 4.X material where possible.
- -

Website

- - - - - - - - - - - - - - - - - - - - - - - - - - -
IssueStatusResponsibleDesired DeadlineDescription
New logo&status.done;&a.kuriyama; Add the new logo on our web site layout and create a logo - page displaying, and providing information on right logo - usage.
Rendering issue&status.new;  After the introduction of new layout, many persons reported a - font size or rendering problems under some browsers configurations - and screen resolutions. These problems should be investigated - and fixed. Reference: - www/91539 -
- -

Manual Pages

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
IssueStatusResponsibleDesired DeadlineDescription
bs(4)&status.new;  New manual page needed for the WD33C93 SCSI driver
nss(4)&status.new;  New manual page needed for the NEC PC-98 sound support
ofwcons(4)&status.new;  New manual page needed for the IEEE-1275 / Open Firmware
wds(4)&status.new;  New manual page needed for the WD7000 SCSI driver
xrpu(4)&status.new;  New manual page needed for the Xilinx FPGA/RPU driver
zs(4)&status.new;  New manual page needed for the Zilog UART driver
Write section 9 manual pages&status.new;&a.trhodes; and &a.hmp; Document kernel interfaces and functions.
Documenting FreeBSD Tunables&status.new;&a.trhodes; Many FreeBSD tunables are undocumented. Everyone knows how - difficult it can be to use an undocumented system, and thus this - project was formed. The initial goal here is to create a tool - which can generate a manual page with the tunables. Hence we need - to generate this list from the source code.
- -

Other Documentations Needs

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
IssueStatusResponsibleDesired DeadlineDescription
CUPS&status.new;  The CUPS system is more and more used, it would be interesting - to have an extensive article in our documentation set. This - article should cover CUPS installation and configuration (with - examples of local and network printers).
NanoBSD&status.done;&a.keramida; &a.danger; contributed both manpage and article for - NanoBSD framework.
Architecture Handbook&status.new;  The FreeBSD Architecture Handbook is lacking in content, - please help us finish this book in writing or updating some - chapters.
- -

Documentation Toolchain Items

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
IssueStatusResponsibleDesired DeadlineDescription
SGML/XML infrastructure update&status.wip;&a.hrs; Add more localization support for XML documentation in the doc - and www tree.
SGML/XML infrastructure update&status.wip;&a.hrs; Use SGML/XML catalog for external file reference for - consistency.
SGML/XML infrastructure update&status.wip;&a.hrs; Add standard entity reference (such as à) support in - XML/XSLT documentation.
- - -