Dokumentation
DOKUMENTATION
Die Dokumentation von Foundation ist kein Prospekt mit angehängter Anleitung. Sie ist das Betriebswissen zur Software und liegt im selben Repository wie der Code, den sie beschreibt — deshalb kann sie nicht von dem abweichen, was sie erklärt, und sie bleibt Ihnen erhalten.
Alles hier ist öffentlich
Sie können die gesamte Dokumentation lesen, bevor Sie entscheiden, ob Foundation zu Ihrem Vorhaben passt, und Sie können sie selbst umsetzen — in Ihrem Tempo, ohne Konto und ohne jemanden fragen zu müssen. Nichts ist gesperrt, und es gibt keine Fassung, die zahlenden Kunden vorbehalten wäre.
Das ist Absicht: Eine Plattform ist nur dann wirklich wiederverwendbar, wenn das Wissen, das man zum Einrichten, Anpassen, Veröffentlichen und Aktualisieren braucht, zusammen mit der Software weitergegeben wird — und nicht bei dem bleibt, der sie geschrieben hat.
Wenn Sie neu anfangen, ist die Reihenfolge einfach: zuerst die README im Repository lesen, dann die Grundversion lokal starten und sich durchklicken, dann das Handbuch zur Aufnahme für Ihr eigenes Projekt. Danach Website-Anpassung und Branding, für den Livegang das Bereitstellungshandbuch und später, wenn eine neuere Version sinnvoll ist, das Upgrade-Handbuch.
Die Betriebshandbücher
Jedes Handbuch ist für sein Thema maßgeblich und für jemanden geschrieben, der Foundation noch nie gesehen hat.
- adoption.md — ein neues Foundation-Projekt anlegen
Wie ein Projekt auf Basis einer unveränderlichen Foundation-Version entsteht, sodass Plattform und Betriebswissen von Anfang an vorliegen.
- deployment.md — eine geprüfte Website in Betrieb nehmen
Der Ablauf und die entscheidenden Prüfungen vor dem Livegang, einschließlich der DNS-Arbeiten, die nur der Inhaber der Domain erledigen kann.
- foundation-upgrade.md — eine neuere Version übernehmen
Wie die Trennung von Plattform- und Anwenderdateien Ihre Konfiguration, Inhalte, Assets und Ihr Branding schützt.
- site-customization.md — Ihre Website anpassen
Was Sie bearbeiten, wie Sie eine Sprache ergänzen und wo die Identität der Website tatsächlich liegt.
- branding-and-assets.md — Marke und Bildrollen
Welche Bildrollen Ihre eigene Gestaltung ersetzt, und in welcher Reihenfolge das geschieht.
- content-management.md — Inhalte pflegen
Wie Seiten, Navigation und Texte als Dateien vorliegen und wie Sie sie ergänzen oder ändern.
- validation.md — die Prüfschranke
Was vor der Annahme einer Änderung geprüft wird und wie Sie diese Prüfungen selbst ausführen.
- troubleshooting.md — den Fehler eingrenzen
Die ersten Schritte, wenn etwas nicht funktioniert: von der Ausgabe der Bereitstellung bis zu Seiten, die nicht erscheinen.
Kein Konto und keine Freigabe nötig
Die Handbücher gehen davon aus, dass Sie in Ihrer eigenen Kopie des Repositories arbeiten, mit Ihrer eigenen Bereitstellung und Ihrer Domain. Es gibt nichts zu registrieren und niemanden zu fragen. Wo ein Schritt etwas voraussetzt, das Sie nicht haben — etwa den Zugang zu den DNS-Einstellungen einer Domain —, sagt das Handbuch es an dieser Stelle offen.