Guide des bonnes pratiques

Voici quelques recommandations de bonnes pratiques pour tout projet réalisé avec Automne. Ces dernières permettent le plus souvent de conserver suffisamment de souplesse pour l’évolution d’un projet sans avoir forcement de caractère fonctionnel obligatoire.

Voir aussi les bonnes pratiques concernant :

Après l’installation

•  Supprimer les fichiers d’installation
• Modifier le mot de passe root 

Directement après l’installation il faut penser à supprimer le fichier install.php et les archives à la racine. Il est également important de se connecter et de modifier le mot de passe et l’adresse email de l’utilisateur root.

Démarrage du développement

Dans les paramètres Automne cochez les options suivantes :

• Activer le débuggage système,
• Activer le débuggage du Polymod,
• Activer les alertes emails des pages 404.

Ces options sont seront utiles pendant vos développements et vous indiqueront l'origine des erreurs. Pensez à désactiver les options de debug lorsque vous êtes en production.

Attention, lorsque le site est en production, l’activation du débug peut perturber l’affichage côté client et présenter des problèmes de sécurité.

En phase d’évolution, modification, ou correction, il faut faire attention, les messages deviennent alors visible côté client mais pour tout le monde.

Pensez également à personnaliser les adresses email de l’administrateur et de l’application.

Racine de l’arborescence

• Créer une première page sous la page 1
• Créer un nouveau site et pointer la racine sur la nouvelle page

La création d’un site ne devrait pas se faire directement sur la page 1, qui est la page racine d’Automne. Il vaut mieux créer une première sous-page - la 2 si on prend le cas d’un Automne vierge - et la designer comme racine de votre site dans la gestion des sites.

Cette bonne pratique vous permettra de créer plusieurs sites au même niveau directement sous la page 1. Dans la plus part des cas, les sites en langues étrangères sont traitées avec des pages racines différentes, toutes des enfants de la page 1. Un projet peut s'internationaliser au cours de son existence, le déplacement de l’arborescence tout en restant faisable devient alors une vraie problématique (structurelle, SEO etc..)

Internationalisation

Si vous devez développer des sites en plusieurs langues, nous vous conseillons d'installer le module Traductions pour la gestion des libellés de vos modèles.

Gestion des droits

• Créer un groupe administrateurs
• Créer votre compte utilisateur

Pour définir les droits du groupe administrateurs, il vous suffit de cocher l'option "Administrateur" dans l'onglet Administration du groupe.

Il est souhaitable d’aborder la définition des droits par groupe et non pas par profil utilisateur. Au démarrage, il existe toujours un petit nombre d'utilisateurs, mais très vite ce nombre peut grandir et poser un problème de gestion. D’autant plus qu’une approche par utilisateur est souvent source d’erreurs lors de modification d’ensemble.

Si vous avez besoin d’activer les droits côté client, faites le, dans la mesure du possible, dès le début du projet. Cela vous évitera de refaire l’ensemble de vos tests. Si ces droits sont activés, pensez à vérifier le site sans être connecté depuis l’administration (en anonyme), sans quoi le résultat serait faussé.

Créez vous un profil utilisateur, ajouter le au groupe d'administrateurs
Ne travaillez pas avec le compte root.

Gestion des fichiers

• Créer un dossier dans /css pour y ranger vos feuilles de styles
• Créer un dossier dans /js pour y ranger vos fichiers javascripts
• Créer un dossier dans /img pour y ranger vos images

Le nom du dossier est laissé à votre appréciation, faites en sorte qu’il puisse être identifier rapidement. Un second site pourrait voir le jour, un dossier spécifique pour chaque permet de mieux identifier a qui appartient les fichiers.

A partir de la version 4.2, si vous nommez votre dossier comme le nom du code d'un site, alors Automne chargera automatiquement vos fichiers JS ou CSS.

Par exemple si le nom de code de votre site est 'fr' vous pouvez décider d'organiser vos fichiers ainsi :

• /css/fr/styles.css
• /css/fr/print.css
• /js/fr/jquery-latest.js
• /js/fr/plugin.jquery.js