Documentation
DOCUMENTATION
La documentation de Foundation n'est pas une plaquette avec un mode d'emploi agrafé derrière. C'est le savoir-faire d'exploitation du logiciel, publié dans le même dépôt que le code qu'il décrit : elle ne peut donc pas s'éloigner de ce qu'elle explique, et elle vous reste acquise.
Tout ce qui se trouve ici est public
Vous pouvez lire l'ensemble de la documentation avant même de décider si Foundation vous convient, et la suivre vous-même, à votre rythme, sans créer de compte et sans demander l'accord de qui que ce soit. Rien n'est réservé, et il n'existe pas de version qui serait gardée pour les clients payants.
C'est délibéré. Une plateforme n'est réellement réutilisable que si le savoir nécessaire pour l'adopter, la configurer, la publier et la maintenir voyage avec le logiciel — au lieu de rester chez celui qui l'a écrit.
Si vous partez de zéro, l'ordre le plus économe est le suivant : d'abord le README du dépôt, pour comprendre ce que Foundation apporte et ce qu'il laisse volontairement de côté ; ensuite, démarrer la base en local et la parcourir avant de lire des spécifications ; puis le manuel d'adoption pour créer votre propre projet. Viennent ensuite la personnalisation du site et l'identité visuelle, le manuel de déploiement pour la mise en ligne sur votre domaine, et plus tard celui des mises à niveau lorsqu'une version plus récente le mérite.
Les manuels d'exploitation
Chaque manuel fait autorité sur son sujet et s'adresse à quelqu'un qui n'a jamais vu Foundation.
- adoption.md — créer un nouveau projet Foundation
Comment un projet est établi à partir d'une version inaltérable de Foundation, afin que la plateforme et le savoir d'exploitation arrivent ensemble.
- deployment.md — mettre en ligne un site déjà validé
Le déroulement et les vérifications décisives avant la mise en ligne, y compris les opérations de domaine et de DNS que seul le titulaire du compte peut effectuer.
- foundation-upgrade.md — adopter une version plus récente
Comment une nouvelle version est adoptée, et comment la séparation entre fichiers de la plateforme et fichiers de l'adoptant protège votre configuration, vos contenus et votre identité.
- site-customization.md — adapter votre site
Ce qu'il faut modifier, comment ajouter une langue et où réside réellement l'identité du site.
- branding-and-assets.md — identité et rôles graphiques
Quels rôles graphiques votre propre matériel peut remplacer, et dans quel ordre.
- content-management.md — tenir les contenus
Comment les pages, la navigation et les textes sont conservés sous forme de fichiers, et comment les compléter ou les modifier.
- validation.md — la barrière de validation
Ce qui est vérifié avant qu'une modification soit acceptée, et comment exécuter ces vérifications vous-même.
- troubleshooting.md — circonscrire le problème
Les premiers pas lorsqu'un comportement n'est pas celui attendu : de la sortie du déploiement aux pages qui n'apparaissent pas.
Par où commencer
L'ordre qui fait perdre le moins de temps. Chaque étape indique le document qui la traite.
Lire ce qu'est Foundation
Le README du dépôt : ce qu'offre la plateforme, ce qu'elle laisse délibérément de côté et à quoi ressemble un site construit sur elle.
L'exécuter en local avant d'en lire davantage
Une heure de pratique répond à plus de questions qu'une journée de documentation.
Décider comment vous en serez propriétaire
Un site ou plusieurs ; vos propres comptes ou un accord géré. Cette décision pèse plus que n'importe quel choix technique.
Créer votre propre projet
Le manuel d'adoption : un projet issu d'une version figée de Foundation, avec la plateforme et le savoir d'exploitation dès le premier jour.
Rendre le site vôtre
Personnalisation et identité : contenus, langues et ressources, par la configuration et les fichiers, sans réécrire la plateforme.
Publier et entretenir
Le manuel de déploiement pour la mise en ligne, celui de mise à niveau pour adopter une version plus récente et celui de validation pour savoir ce qui est vérifié.
Aucun compte et aucune autorisation
Les manuels supposent que vous travaillez dans votre propre copie du dépôt, avec votre propre hébergement et votre propre domaine. Il n'y a rien à enregistrer et personne à qui demander. Lorsqu'une étape exige ce que vous n'avez pas — l'accès aux réglages DNS d'un domaine, par exemple — le manuel le signale à cet endroit précis plutôt que de le laisser découvrir plus tard.