Differences between revisions 3 and 4
Revision 3 as of 2005-06-03 11:10:31
Size: 1165
Editor: anonymous
Comment:
Revision 4 as of 2008-11-25 22:32:39
Size: 2481
Editor: FranklinPiat
Comment: Rewrite page (almost completly).
Deletions are marked like this. Additions are marked like this.
Line 1: Line 1:
## Auto-converted by kwiki2moinmoin v2005-10-07 #language en

Debian is a distribution, made of many thousands (free) software :
 1. Most softwares provided in Debian comes with their own documentation ([#progs-docs more below]).
 1. Debian has some ''own'' documentation too ([#debian-docs more below]).

 1. At the bottom of the page, there are some pointers if you want to contribute improvement to documentation ([#contribute more below]).

[[BR]]
[[BR]]
[[BR]]

[[Anchor(progs-docs)]]
== Programs documentations ==
Under Debian (Unix), a program's documentation typically consist of (one or more of):
 * A [:ManPage:manpage] (type {{{man}}} followed by a command name).
 * A {{{README}}} file, provided by upstream. (A text file located at {{{/usr/share/doc/}}}''pkgname''{{{/README}}})
 * A {{{README.Debian}}} file, provided by the Debian package maintainer. (A text file located at {{{/usr/share/doc/}}}''pkgname''{{{/README.Debian}}})
 * Programs with a graphical user interface (Gnome, KDE...) usually comes with help page (accessible through {{{Menu > Help}}}).
 * Some program provide their documentation as html, or ''[wiki:WikiPedia:Info_(Unix) info]'' page.

[[Anchor(debian-docs)]]
== Debian Documentation ==

The most famous for Debian users are :
 * The Installation Guide ~-[[BR]]. [http://www.debian.org/doc/user-manuals#install][[BR]]. (or development version, available at [http://d-i.alioth.debian.org/manual/]-~
 * The Release Notes ~-[[BR]]. [http://www.debian.org/doc/user-manuals#relnotes]-~
 * The Debian reference ~-[[BR]]. [http://www.debian.org/doc/user-manuals#quick-reference]-~

Many other Debian Documentation are available at [http://www.debian.org/doc www.debian.org/doc]

At the moment, Debian don't have a ''System Administrtor'' manual. However, there are some books about Debian, see: [http://www.debian.org/doc/books www.debian.org/doc/books].


Most documentation for Debian-developer (and package maintainer) are available from [http://www.debian.org/devel/ www.debian.org/devel/]


[[Anchor(contribute)]]
== Contribute to documentation ==
Line 4: Line 43:
Unfortunately, the DDP needs to be relaunched, there are not enough members in the project and few new members are joining the project. Meanwhile, other documentation projects such as Ubuntu (http://www.ubuntulinux.org/community/participate#documentation) or Gentoo (http://www.gentoo.org/doc/en/index.xml) are doing a better job at having new users join the project and develop new content and create translations.  {i} This is free software, __you can contribute improvements to the documentation__ ~-[[BR]]''(i.e you don't have to write your own Howto !)''-~.
Line 6: Line 45:
Currently, there are several user manuals which are maintained, up-to-date and have a large number of translations including:

 * The Install Manual, available at http://www.debian.org/doc/user-manuals#install, d-i's version is available at http://d-i.alioth.debian.org/manual/

 * The Release document, available at http://www.debian.org/doc/user-manuals#relnotes

 * The Debian reference, available at http://www.debian.org/doc/user-manuals#quick-reference

Most developer manuals are not translated, but are up-to-date.

We still lack a sysadmin manual and an up-to-date user manual like most other distributions do.
## SIMILAR PAGES (ideas to attract more contributors ??)
## - http://www.ubuntulinux.org/community/participate#documentation
## - http://www.gentoo.org/doc/en/index.xml

Debian is a distribution, made of many thousands (free) software :

  1. Most softwares provided in Debian comes with their own documentation ([#progs-docs more below]).
  2. Debian has some own documentation too ([#debian-docs more below]).

  3. At the bottom of the page, there are some pointers if you want to contribute improvement to documentation ([#contribute more below]).

?BR ?BR ?BR

?Anchor(progs-docs)

Programs documentations

Under Debian (Unix), a program's documentation typically consist of (one or more of):

  • A [:ManPage:manpage] (type man followed by a command name).

  • A README file, provided by upstream. (A text file located at /usr/share/doc/pkgname/README)

  • A README.Debian file, provided by the Debian package maintainer. (A text file located at /usr/share/doc/pkgname/README.Debian)

  • Programs with a graphical user interface (Gnome, KDE...) usually comes with help page (accessible through Menu > Help).

  • Some program provide their documentation as html, or [wiki:Info_(Unix) info] page.

?Anchor(debian-docs)

Debian Documentation

The most famous for Debian users are :

Many other Debian Documentation are available at [http://www.debian.org/doc www.debian.org/doc]

At the moment, Debian don't have a System Administrtor manual. However, there are some books about Debian, see: [http://www.debian.org/doc/books www.debian.org/doc/books].

Most documentation for Debian-developer (and package maintainer) are available from [http://www.debian.org/devel/ www.debian.org/devel/]

?Anchor(contribute)

Contribute to documentation

Most of the Debian Documentation is available at http://www.debian.org/doc/ddp

  • {i} This is free software, you can contribute improvements to the documentation ~-?BR(i.e you don't have to write your own Howto !).