Differences between revisions 21 and 22
Revision 21 as of 2017-06-10 13:55:41
Size: 6876
Editor: OsamuAoki
Comment:
Revision 22 as of 2017-06-18 17:55:15
Size: 7004
Comment: some minor grammar fixes
Deletions are marked like this. Additions are marked like this.
Line 4: Line 4:
Line 116: Line 115:
= Contribute to documentation = = Contribute to the documentation =
Line 118: Line 117:
 {i} This is free software, __you can contribute improvements to the documentation__ ~-<<BR>>''(i.e you don't have to write your own Howto !)''-~.  {i} This is free software, __you can contribute improvements to the existing documentation__ ~-<<BR>>''(i.e. you don't have to write your own !HowTo!)''-~.
Line 120: Line 119:
If you are interested in contributing to documentation, please check following resources first to get some feel for how other people contribute: If you are interested in contributing to documentation, please check the following resources first, to get some feel for how other people contribute:
Line 122: Line 121:
 * https://wiki.debian.org/ (Join this wiki and add new contents/translation)
 * http://lists.debian.org/debian-www/recent (mailing list)
 * http://lists.debian.org/debian-doc/recent (mailing list)
 * https://wiki.debian.org/ (Join this wiki and add new contents/translations)
 * http://lists.debian.org/debian-www/recent ([[DebianMailingLists|mailing-list]])
 * http://lists.debian.org/debian-doc/recent ([[DebianMailingLists|mailing-list]])
Line 126: Line 125:
 {i} Some documentation contents are generated from the Debian package. If so, you may wish to interact with the package maintainer. Sometimes, filing bug report to its [[BTS|https://www.debian.org/Bugs/]] is good idea.  {i} Some documentation contents are generated from the corresponding Debian package. If so, you may wish to interact with the package maintainer. Sometimes, filing a bug report for that package using the [[BTS|Debian Bug Tracking System (BTS)]] is a good idea.
Line 128: Line 127:
If you are interested with participate in the debian-doc group, Please follow: [[Teams/DDP]] If you are interested in participating in the debian-doc group, please see the [[Teams/DDP|team page on the Wiki]]

Translation(s): English - Français - Italiano


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

This page is about official Debian Documentation.

There are other Debian Resources

Debian Documentation

For users

The most famous for Debian users are :

Many other Debian Documentation are available at www.debian.org/doc

At the moment, Debian doesn't have a System Administrator manual.

For contributors

The most famous for Debian contributors are :

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

Official Websites of the Debian Project

The Debian Project has a constitution and an organizational structure

On Debian.org the official Debian site, you can find a section dedicated to documentation.

Forum

Advocacy, developers, inside information

Wiki

Debian Related Wikis

Books

Many free and non-free books are listed on Debian website.

Extra books could be listed below.

Instant Messaging

There are official Debian IRC channels.

You can also use Jabber

Program documentation

Each software provides has its own documentation.

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

  • A 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 info page.

Package Description

In the package description you can find some useful information, like a short description of the package, a link to the original website, a list of files contained, and more. The package description can be accessed at the url http://packages.debian.org/<package-name>. Or, try "aptitude show $PKG" (you may need to "apt-get update && apt-get aptitude && aptitude update" first).

One of the best places to look for help for a single package or application is to read stuff in /usr/share/doc/<package-name> (especially README.Debian). This is documentation written by developers or package maintainers. It is quite concise, but usually mentions most common problems and solutions, and new features and fixed bugs.

Bug tracking system

Many problems' solutions can be found as bug report responses. A search engine for bug reports is found on http://bugs.debian.org. Remember that if you want to search in archived (quite old) bugs you must chose "archived bugs" option. If you want to look at bugs of a specific package use http://bugs.debian.org/<package-name>.

Contribute to the documentation

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

If you are interested in contributing to documentation, please check the following resources first, to get some feel for how other people contribute:

If you are interested in participating in the debian-doc group, please see the team page on the Wiki

See also