Transloadit kündigt komplette Überarbeitung der Dokumentation an
Als wir Transloadit vor zehn Jahren gestartet und begonnen haben, unser Projekt zu dokumentieren, behandelte die Dokumentation das Hochladen zu S3, unser jQuery SDK (English), die Größenänderung von Bildern und das Encoding von Videos. Rückblickend war das nur ein kleiner Anfang im Vergleich zu dem, was noch kommen sollte.
Seitdem haben wir Transloadit zu dem umfangreichen Unternehmen ausgebaut, das es heute ist, und 19 weitere Integrationsmöglichkeiten, API2, unzählige Infrastruktur- und Sicherheits-Upgrades und natürlich 93 zusätzliche Features auf den Weg gebracht:
Eingabe
Dateiimport
- Dateien aus Azure importieren
- Dateien aus Backblaze importieren
- Dateien aus Box importieren
- Dateien aus MEGA S4 Object Storage importieren
- Dateien aus Rackspace Cloud Files importieren
- Dateien aus Cloudflare R2 importieren
- Dateien aus DigitalOcean Spaces importieren
- Dateien aus Dropbox importieren
- Dateien von FTP-Servern importieren
- Dateien aus Google Cloud Storage importieren
- Dateien von Webservern importieren
- Dateien aus MinIO importieren
- Dateien aus Amazon S3 importieren
- Dateien von SFTP-Servern importieren
- Dateien aus Supabase Storage importieren
- Dateien aus OpenStack Swift importieren
- Dateien aus Tigris importieren
- Videos aus Vimeo importieren
- Dateien aus Wasabi importieren
- Viele weitere über Zapier
Prozess
Video-Encoding
- Videos in HLS, MPEG-Dash und CMAF konvertieren
- Video-Coverbilder extrahieren oder einfügen
- Videos zusammenfügen
- Videos transkodieren, skalieren oder mit Wasserzeichen versehen
- Video, Audio und Bilder zu einem Video zusammenführen
- Videos mit On-Demand-Encoding streamen
- Video aufteilen
- Untertitel zu Videos hinzufügen
- Thumbnails aus Videos extrahieren
Audio-Encoding
Bildverarbeitung
Dokumentenverarbeitung
- Dokumente automatisch drehen
- Dokumente in verschiedene Formate konvertieren
- Text und eingebettete Bilder extrahieren
- Dokumente in einer Datei zusammenführen
- PDF-Dateigröße optimieren (English)
- Dateiinhalte lesen
- Seiten extrahieren
- Thumbnails aus Dokumenten extrahieren
- Screenshots von Webseiten oder HTML-Dateien erstellen
Künstliche Intelligenz
- Text in Dokumenten erkennen (OCR)
- Objekte in Bildern erkennen
- Gesichter in Bildern erkennen
- Bilder aus Text-Prompts erzeugen
- Bilder hochskalieren (English)
- Text in Bildern erkennen (OCR)
- Sprache in Audio- oder Videodateien transkribieren
- Sprache aus Dokumenten synthetisieren
- Text in Dokumenten übersetzen
- KI-Chat-Antworten generieren (English)
- Videos aus Text-Prompts erzeugen
Medienkatalogisierung
Ausgabe
Dateiexport
- Dateien zu Microsoft Azure exportieren
- Dateien zu Backblaze exportieren
- Dateien zu Box exportieren
- Dateien zu MEGA S4 Object Storage exportieren
- Dateien zu Rackspace Cloud Files exportieren
- Dateien zu Cloudflare R2 exportieren
- Dateien zu DigitalOcean Spaces exportieren
- Dateien zu Dropbox exportieren
- Dateien auf FTP-Server exportieren
- Dateien zu Google Cloud Storage exportieren
- Dateien zu MinIO exportieren
- Dateien zu Amazon S3 exportieren
- Dateien auf SFTP-Server exportieren
- Dateien zu Supabase Storage exportieren
- Dateien zu OpenStack Swift exportieren
- Dateien zu Tigris exportieren
- Dateien zu tus-kompatiblen Servern exportieren
- Dateien zu Vimeo exportieren
- Dateien zu Wasabi exportieren
- Dateien zu YouTube exportieren
- Viele weitere über Zapier
All diese Dinge erforderten Dokumentation, die wir nach und nach ergänzt haben. Ganz im Sinne der Trennung von Zuständigkeiten sind unsere Entwicklerinnen und Entwickler dafür verantwortlich, die Dokumentation gemeinsam mit ihren neu entwickelten Features auszuliefern. Sie sind außerdem angehalten, Themenfremdes aus ihren Pull Requests herauszuhalten, sodass bestehende Dokumentation nur selten angefasst wird.
Das bedeutet allerdings auch: Da sie über die Jahre organisch gewachsen ist, konnte unsere Dokumentation anfangen, sich zu widersprechen oder dieselben Informationen mehrfach zu wiederholen. Um dem entgegenzuwirken, muss alle Jubeljahre jemand das Ganze auf der Suche nach diesen Ungereimtheiten durcharbeiten oder die Dokumentation sogar vollständig neu schreiben.
Wir haben unsere Dokumentation zu lange vernachlässigt: Die letzte Überarbeitung liegt rund fünf Jahre zurück. Die alte Dokumentation enthielt noch Verweise auf unser jQuery SDK, während die empfohlene Browser-Integration heute Uppy ist. Außerdem zeigte sie Beispiele mit direkt eingebundenen Assembly Instructions, während heute empfohlen wird, diese in Templates vorzuhalten. Angesichts all dessen wussten wir: Es war Zeit, der Dokumentation auf ganzer Linie etwas Zuwendung zu schenken. Wir bedauern, dass es so lange gedauert hat, unseren Garten wieder zu jäten!
Umso mehr freuen wir uns, ankündigen zu können, dass wir soeben eine weitere vollständige Überarbeitung unserer Dokumentation abgeschlossen haben. Sie können sie sich in unserer Dokumentation ansehen. Von den sechs Hauptbereichen der Dokumentation wurde unser wichtigster Bereich, die „Integrationsdokumentation“, komplett neu geschrieben. Es hat volle zwei Wochen gedauert (und viele Wochen davor voller fürchterlicher Aufschieberei), aber es hat sich absolut gelohnt.
Es gibt einige wesentliche Unterschiede zwischen der alten und der neuen Version der Dokumentation. Früher war Folgendes der Fall:
- Die Dokumentation war nach Schwierigkeitsgrad kategorisiert (Grundlagen, Fortgeschrittenes, 5-Minuten-Rundgang), jetzt ist sie nach Themen gegliedert, mit einem einzigen Rundgang für den Einstieg. Was für die einen leicht ist, ist für die anderen schwierig, und Zeit und Aufwand für einen Abschnitt der Dokumentation sagen wenig über dessen Zweck oder Nutzen aus.
- Sie verwies auf das jQuery SDK als unseren bevorzugten Weg, jetzt setzen wir durchgehend auf Uppys Robodog Plugin.
- Codebeispiele in der Dokumentation litten unter Bitrot, jetzt wurde jeder Code, den Sie sehen, tatsächlich getestet und funktioniert nachweislich im Jahr 2020.
- Sie zeigte direkt eingebundene Assembly Instructions und fügte an vielen Stellen große Hinweise hinzu, dass wir Templates empfehlen, jetzt verwenden wir in unseren Beispielen von Anfang an Templates.
- Sie enthielt Beispiele mit unterschiedlichen und veralteten Assembly Instructions, jetzt speist sich die gesamte Dokumentation aus einer einzigen, funktionierenden Demo zur Gesichtserkennung (English).
- Sie enthielt Integrationsbeispiele, die dupliziert waren und dadurch auseinanderliefen und veralteten, jetzt verwenden all diese Stellen denselben Code, den auch die Demos (English) nutzen.
Hinweis: Robodog wurde abgekündigt. Verwenden Sie für neue Integrationen Uppys Transloadit Plugin (Dashboard-UI oder eine eigene UI).
Wir hoffen sehr, dass das Ergebnis deutlich konsistenter und DRY ist und für ein reibungsloseres Onboarding sorgt. Lassen Sie uns wissen, was Sie davon halten!