Annexe E. Comment apporter votre contribution ?
- Table des matières
- 1. Description
- 2. Pré-requis
- 2.1. Pré-requis théorique
- 2.2. Pré-requis matériel
- 2.3. Pré-requis logiciel
- 3. Télécharger les sources
- 4. Installer
- 5. Configurer
- 6. Utiliser
- 7. Désinstaller
- 8. Annexe(s)
Tableau E-1. Evolution de cet article
| Date | Ajout(s) / Modification(s) |
|---|---|
| 10 juillet 2003 | Version initiale |
| 17 juillet 2003 | On explique le contenu des différentes parties de cet article |
| 18 juillet 2003 | Ajout d'une partie Description. |
| 19 aout 2003 | Ajout d'une script qui permet de générer automatiquement des articles. |
| 27 octobre 2003 | Relecture. |
Vous voulez enrichir ce guide de l'utilisateur en y apportant votre contribution personnelle ??? Sachez que vous êtes le (ou la) bienvenue. Ce guide de l'utilisateur commence à s'étoffer de plus en plus et pour garder une certaine homogénéité au fil des pages, j'ai mis en place un squelette pour l'ensemble des articles de ce guide de l'utilisateur. Je vous laisse le soin de consulter l'annexe
Cette annexe sert de squelette à la majorité des articles présents dans ce guide de l'utilisateur. Si vous désirez apporter votre contribution, vous devez essayer de faire apparaître dans votre futur article les parties qui sont décrites ci-dessous. Si vous n'avez rien à mettre dans une partie (en particulier dans les premières), vous pouvez la supprimer complétement. Évitez le plus possible d'ajouter d'autres parties à votre article si vous pouvez inclure votre texte dans les parties existantes. Pour chaque partie vous êtes libre de créer autant de sous parties que vous le souhaitez.
Pour que je publie votre article dans ce guide de l'utilisateur vous devez me le soumettre par mail à l'adresse [email protected]. Ce guide de l'utilisateur étant rédigé en SGML, je vais devoir retoucher le document que vous allez me soumettre. N'attachez donc pas trop d'importance à la mise en page. Le plus important est le fond de votre article. Respectez le plus possible les parties qui sont décrites ci-dessous.
 | Rédaction de votre article |
|---|---|
Enregistrez cette page tel quelle et ouvrez la avec votre éditeur de texte favori. Vous n'aurez plus qu'à supprimer mes commentaires et les remplacer par le contenu de votre article NEW : Depuis le 19/08/2003 vous pouvez également rédiger votre article directement en ligne. Pour cela rendez-vous sur le générateur d'articles. |
1. Description
Cette partie décrit l'article. Ce qu'il permet de faire...
2. Pré-requis
Cette partie permet de faire le point sur ce que le lecteur doit savoir (théorie) et posséder (matériel et logiciel) pour pouvoir exploiter correctement votre article
2.1. Pré-requis théorique
Ici on parle des compétences théoriques à posséder. On peut demander par exemple, au lecteur de maitrîser la compilation du noyau, ou le système de fichiers Ext3.
2.2. Pré-requis matériel
Ici on liste le matériel que l'on doit posséder pour pouvoir faire fonctionner l'article. Dans le cadre d'un article qui traite par exemple, de la configuration d'une imprimante USB, on demandera à l'utilisateur de vérifier qu'il possède bien un port USB sur sa machine (et de plus qu'il soit libre). Cela peut paraître évident pour tout le monde, mais il m'est déjà arrivé de rencontrer des utilisateurs qui n'arrivaient pas à installer une imprimante USB tout simplement parce que leur imprimante foncionnait sur port parallèle uniquement.
2.3. Pré-requis logiciel
Ici on énumère tout ce qu'il faut avoir au préalable installé sur sa machine. Par exemple, si il y a déjà un article qui traite de l'installation du support USB dans le noyau, on demandera simplement à l'utilisateur que son noyau supporte l'USB. Si il n'y a pas d'article qui traite de l'installation du support USB dans le noyau et bien on ne doit pas expliquer la procédure ici car elle est très longue. On écrira l'article plus tard.
3. Télécharger les sources
Si l'on doit au préalable télécharger des sources (autres que les paquets qui sont disponibles par apt-get) on les indique ici !
4. Installer
Voici un modèle de texte que l'on peut recopier pour l'installation d'un paquet.
4.1. Exemple à recopier
Nous allons installer le paquet phpmyadmin qui contient :
import le programme qui permet de faire une capture d'écran (totale ou partielle) de l'affichage de votre serveur X
# apt-get install phpmyadmin |
Une fois le paquet installé, vous devez répondre aux questions suivantes:
5. Configurer
Cette partie explique les étapes de configuration. En général on parle ici du fichier de configuration de l'application que l'on vient d'installer (si elle en possède un) ou des écrans d'options de l'application (qu'elle soit graphique ou texte).
5.1. Exemple de sous-partie : Fichier de configuration
On décrit ici le contenu du fichier de configuration de l'application que l'on a installé.
6. Utiliser
Ici on détaille les différentes fonctionnalités de notre application.
7. Désinstaller
Voici un modèle de texte que l'on peut recopier pour la désinstallation du ou des paquets que l'on a precedement installé. Il est intéressant de faire figurer les dépendances qui ont été installées. Même si c'est un peu risqué de les supprimer.
7.1. Exemple à recopier
# apt-get remove phpmyadmin |
| Supprimer toute trace du package précédement installé | |
|---|---|---|
Lorsque vous décidez de retirer un package de votre Debian GNU/Linux APT n'efface par les fichiers de configuration de ce package. Ceci permet de réinstaller plus rapidement la package. Cependant si vous souhaitez faire table rase et ne plus entendre parler du package, vous pouvez ajouter l'option --purge lors de la suppression.
|
Si vous souhaitez retirer tous les composants qui ont été installés par le paquet phpmadmin :
# apt-get remove apache apache-common libz2-1-0
libdc4.1 libexpat1 libmm13 libmysqlclient10 mine-support
mysql-common php4 php4-mysql wwwconfig-common
zlib1g |
| Supprimer toutes les dépendances d'un package précedement installé | |
|---|---|---|
Un package (père) a souvent besoin d'autres packages pour pouvoir fonctionner correctement. Ces nouveaux packages forment les dépendances du package père. Cependant d'autres packages peuvent avoir des dépendances similaires. Lorsque vous décidez de retirer tous les dépendances d'un package de votre Debian GNU/Linux vous risquez de rendre votre système instable. Pour ne pas avoir ce problème, vérifiez que la commande APT n'efface pas d'autres packages que ceux que vous avez spécifié. Comme dans l'exemple ci-dessous :
|
8. Annexe(s)
Si vous avez des annexes à mettre c'est ici !
8.1. Nom de votre annexe
Contenu de l'annexe