Hilf uns, unsere Dokumentation zu verbessern
Wir suchen Übersetzer! Wir suchen Übersetzer, um diese Spezifikation für alle zu übersetzen!
We work out of a slack workspace, feel free to come join us!
Hilf mit die all-contributors Dokumentation zu verbessern!
Vielen Dank für Dein Interesse an diesem Projekt! Pull Requests sind für jegliche Art der Verbesserung gern gesehen, vom kleinen Schreibfehler bis hin zu ganz neuen Abschnitten. Jeder Beitrag hilft das Projekt als Ganzes zu verbessern
Der ganze Quellcode ist auf github.com/all-contributors/all-contributors verfügbar
Onboarding von neuen Mitwirkenden
Wir bieten Onboarding für neue Mitwirkende an. Wenn Du interessiert daran bist, teil zu nehmen, schreibe bitte kurz in dem Slack Channel.
Zum all-contributors Repository beitragen
Wir verwenden die angular commit convention für Commits, die für eine automatisierte Changelog-Generation verwendet werden. Daher wäre es ratsam, diese anzuerkennen. Wenn dir diese nicht geläufig ist oder du Angst haben solltest einen Fehler zu machen, kannst du jederzeit npm run commit
oder git cz
(wenn Du commitizen
installiert hat) aufrufen, welche dich anhand einiger Fragen durch den Prozess führen und schlussendlich den Commit für dich schreiben which would take you through a few questions and write the commit for you.
Inhalt bearbeiten
Tipp: Jede Seite hat ein Bearbeiten Knopf. Klicke ihn, um direkt zum Quellcode für diese Seite auf GitHub zu gelangen
Bist du auf einer Datei angelangt, klicke das Stiftsymbol um die Datei zu bearbeiten
Übersetzungen
Unsere Übersetzungen werden über Crowdin verwaltet. Du kannst dazu beitragen, indem Du auf das crowdin-Projekt gehst und dort Übersetzungen vorschlägst. Wenn du helfen möchtest kannst du dich unter diesem Issue auf GitHub melden. Ebenfalls stehen wir dir dort für Fragen zur Übersetzung zur Verfügung!
When translating, it's important that anything that has the XPATH
@href
,@src
etc should not be translated. Dinge wiecode
sollten ebenfalls nicht übersetzt werden. Dadurch entstehen 404 Fehler. Sieh dir dieses Beispiel Bild an:Es wird jedoch empfohlen, alle Inhalte zu übersetzen, die zu einem besseren Verständnis, wie die Kommentare im
Code
Tag, beitragen würden, solange es den aktuellen Code nicht ändert, da dieser nur Englisch versteht.
Anleitungen
Bei Crowdin anmelden
- Geh auf das Crowdin Projekt, und registriere und/oder melde dich an.
- Trete dem "All Contributors" Projekt bei und voila, du bist dabei!
Übersetzen
- Gehe zum Crowdin Projekt.
- Klicke auf die Flagge der Sprache, die Du übersetzen möchtest.
- Klicke auf irgendeine der
*.md
Dateien, welche nicht vollständig übersetzt sind (Siehe auch Fortschrittsbalken rechts) - Schreibe deine Übersetzung im "Enter translation here" Feld (das der Übersetzung des Textes im "SOURCE STRING" Feld oben entspricht) und klicke auf "SAVE"
- Nur für proofreaders: Sie können die Übersetzungsvorschläge genehmigen (ob es von Ihnen oder jemand anderem gemacht wird), die Sie in der "[LANGUAGE] TRANSLATIONS" Sektion finden können, durch klicken auf das :ballot_box_with_check: oder um sie zu löschen durch klicken auf das :wastebasket: Symbol.
Change Deployments
Nachdem du Strings in irgendeiner Sprache übersetzt hast, wirst du diese Änderungen nicht live sehen, bis der Master
Branch von einem erfolgreichen Deployment aktualisiert wurde.
Suche
Die Suche basiert auf algolia. Die Konfiguration ist auf https://github.com/algolia/docsearch-configs/blob/master/configs/all-contributors.json zu finden
Die Seite lokal laufen lassen:
All Contributors benutzt Docusaurus um die Dokumentationsseite zu verwalten. Für weitere Informationen besuche die Docusaurus Webseite
Um lokal zu beginnen:
yarn install
yarn start
- Gehe auf
http://localhost:3000
(Aktualisiere die Seite, um Deine Änderungen zu sehen)
Dich selbst als Beitragenden hinzufügen
Um Dich selbst in die Tabelle der Mitwirkenden einzufügen, folge den Anweisungen der Dokumentation zur Nutzung des Bots ;).