Dokumentation und Hilfeseiten beitragen
Die Hilfe, die Sie gerade lesen, ist freie Dokumentation, in Markdown geschrieben und im Repository unter
doc/eng-us/ abgelegt. Alle können sie verbessern, und Programmierkenntnisse sind nicht nötig.
Inhalt
- Eine Seite korrigieren
- Eine neue Seite schreiben
- Stilregeln
- Ihre Seite prüfen
- Die Lizenz
- Andere Orte zum Schreiben
Eine Seite korrigieren
Jede Hilfeseite hat einen Link „Auf GitHub bearbeiten“. Öffnen Sie ihn, ändern Sie den Text im Browser und schlagen Sie die Änderung als Pull Request vor (Dokumentation beitragen). Tippfehler, veraltete Schritte und unklare Sätze sind alle willkommen.
Eine neue Seite schreiben
Eine Hilfeseite ist eine Markdown-Datei unter doc/eng-us/help/, die mit Front Matter beginnt:
---
title: <Title>
audience: editor, admin
category: editing
order: 50
summary: <One or two sentences: who it is for and what it answers.>
keywords: <comma separated>
type: help
---
# <Title>Die Werte für audience und category, die die Hilfe versteht, sind in settings/exphelp.ini konfiguriert
(Dokumentation beitragen). Hilfeseiten enden mit einer Liste
„Verwandte Seiten“. Die Hilfe zeigt die Dateien, die Git verfolgt; eine neue Seite erscheint also, sobald sie
committet ist.
Stilregeln
- Amerikanisches Englisch; „Exponential“ für das Produkt; der alte Name nur für die Geschichte.
- Jede Tatsache mit ihrer Quelle: eine Datei, eine Seite oder ein Befehl mit seiner erwarteten Ausgabe.
- Schritte, die auf einer aktuellen Installation funktionieren; nennen Sie die Version, mit der Sie getestet haben.
- Keine Geheimnisse, keine privaten Hostnamen, keine personenbezogenen Daten in Beispielen.
- Tabellen und Checklisten, wo sie helfen; kurze Sätze.
Ihre Seite prüfen
In einem Klon prüft ./console exp:help check „die Links und Bilder der Seiten“ (bin/php/exphelp.php); beheben Sie
jeden aufgeführten Fehler, bevor Sie den Pull Request eröffnen. ./console exp:help show <page id> zeigt die
Metadaten und Überschriften einer Seite. Das Hilfesystem beschreibt Das Hilfesystem.
Die Lizenz
Die Dokumentation steht unter der GNU Free Documentation License 1.3 oder neuer; Ihr Beitrag wird unter derselben Lizenz veröffentlicht, sodass andere ihn kopieren, übersetzen und verbessern dürfen (Freie Dokumentation).
Andere Orte zum Schreiben
| Ort | Was | Seite |
|---|---|---|
| eZpedia | Eine Community-Enzyklopädie unter der GFDL, für Kniffe und Anleitungen | Zu eZpedia beitragen |
| Share | Blogs, Artikel, Tutorials | Auf Share und Projects veröffentlichen |
Verwandte Seiten
- Als Community-Mitglied mitwirken
- Die Hilfe verbessern
- Die Hilfe aktuell halten
- Die Hilfe korrekt halten
- Freie Dokumentation: Diese Seite darf unter der GNU FDL 1.3 frei kopiert, übersetzt und verbessert werden.
Werden Sie Exponential-Partner
Partner teilen ihre Informationen, stellen Mittel bereit, geben Beiträge zurück und entwickeln die Produkte mit uns, und so wächst Exponential. Eine Partner-Website und ein Dashboard sind für Mitte 2027 geplant: Werden Sie noch heute Partner, damit wir schneller wachsen und neue Funktionen früher liefern.