Auf DoliNews veröffentlichen
Von der Kontoeröffnung bis zum ersten veröffentlichten Artikel.
Hier ist jede Information datiert: Ihre Ankündigung nennt Kompatibilität und Reife des Moduls an dem Tag, an dem Sie sie veröffentlichen. DoliNews beansprucht nicht, den aktuellen Stand eines Moduls zu beschreiben, sondern nur das, was Sie angekündigt haben, und wann. Das Blatt Ihres Projekts dagegen ist dauerhaft: es trägt weder Kompatibilität noch Reife.
Zwei Dinge vorab. Schreiben setzt ein Beitragendenkonto voraus, also einen Nachweis, dass Sie tatsächlich zum Ökosystem beigetragen haben: Lesen und Abonnieren nicht. Und jede Ankündigung durchläuft die Prüfung: ein API-Token gibt das Recht einzureichen, nie das Recht zu veröffentlichen. Nur ihre Übersetzungen sind ausgenommen, da der Text, den sie übersetzen, bereits geprüft wurde.
1. Das Konto eröffnen
Die Anmeldung ist frei und ergibt ein Leserkonto. Eine Bestätigungs-E-Mail geht sofort heraus: der enthaltene Link ist einmalig und schaltet das Konto frei.
Verwenden Sie möglichst die Adresse, mit der Sie Ihre Commits signieren. Ist sie dem Autorenindex bereits bekannt, wird Ihr Konto in dem Moment zum Beitragendenkonto, in dem Sie die E-Mail bestätigen, und der nächste Schritt betrifft Sie nicht.
2. Ihren Beitrag nachweisen
Die Qualifizierung ist etwas anderes als die Authentifizierung: erst besteht das Konto, dann kommt der Nachweis. Der Dienst sucht Ihre Commit-Autorenadresse in einem Index, der aus Git-Klonen der Referenz-Repositories gewonnen wurde - nie über die API einer Forge, damit die Prüfung das Verschwinden eines Anbieters überlebt.
Ihre Adresse wird nie im Klartext aufbewahrt, weder im Index noch am Nachweis: gespeichert wird nur ihr gepfefferter Hash.
Ist die Adresse erkannt, bleibt zu beweisen, dass sie Ihnen gehört. Zwei Stufen:
- Einfach: ein Einmalcode geht an die Commit-Adresse, eine Stunde gültig, fünf Versuche.
- Stark: der Dienst gibt Ihnen einen Satz, den Sie mit dem GPG-Schlüssel Ihrer Commits signieren; Sie fügen Ihren öffentlichen Schlüssel und die Signatur ein.
Drei Fälle, in denen der einfache Weg nicht greift:
- Ihre Commit-Adresse ist eine anonymisierte Weiterleitung, wie Forges sie vergeben: sie empfängt keine E-Mail, es bleiben die GPG-Signatur oder die manuelle Freigabe.
- Ihre Adresse taucht in keinem Referenz-Repository auf: bitten Sie das Team auf derselben Seite um die manuelle Freigabe und schildern Sie Ihre Lage. Das ist der Weg für Herausgeber ohne öffentliches Repository.
- Diese Adresse gehört bereits zu einem anderen Konto: ein Hash qualifiziert nur ein Konto, und ein von der Moderation widerrufener Nachweis wird nie durch einen Automatismus zurückgegeben.
3. Ihren Herausgeber anlegen
Der Herausgeber ist die Organisation oder Person, die veröffentlicht; Ihre Projektblätter und Ankündigungen gehören ihm. Man veröffentlicht nie im eigenen Namen: ohne Herausgeber lässt sich nichts einreichen. Das Anlageformular erscheint, sobald Ihr Beitragsnachweis angenommen ist, und bleibt unten auf der Seite Ihrer Artikel erreichbar. Eine Integration, die bei null anfängt, legt ihren Herausgeber eher über POST /editors an. Sie sind Eigentümer des Herausgebers, den Sie anlegen, und können weitere Beitragendenkonten anhängen, die dann unter demselben Namen veröffentlichen.
Ein eigener Herausgeber je Konto: das Veröffentlichungsguthaben und die Obergrenze der Warteschlange zählen je Herausgeber. Zu weiteren kommt man auf Einladung ihres Eigentümers.
4. Ein API-Token erstellen
Das Token dient zum Veröffentlichen aus Ihrer Integrationskette und wird im nächsten Schritt gebraucht. Benennen Sie es nach seinem Zweck: das Geheimnis erscheint nur einmal, beim Anlegen, und lässt sich jederzeit widerrufen.
Es wird als Kopfzeile bei jedem Aufruf mitgegeben. Prüfen Sie zuerst, ob es antwortet:
TOKEN="12|..."
curl -H "Authorization: Bearer $TOKEN" -H "Accept: application/json" \
https://dolinews.com/api/v1/profileDie Antwort trägt die beiden Werte, von denen jeder Schreibzugriff abhängt: is_contributor und die Liste Ihrer Herausgeber mit ihrer Kennung. Notieren Sie diese Kennung, die folgenden Aufrufe fragen danach.
Rate: 120 Lese- und 10 Schreibzugriffe pro Minute. Ein Skript, das mehrere Bilder hintereinander hochlädt, muss die zweite Grenze einplanen.
5. Das Projektblatt anlegen
Das Blatt beschreibt das Projekt dauerhaft: Name, Kurzfassung, Beschreibung, Lizenz, typisierte Links zum Repository, zur Dokumentation, zum Shop oder zum Support. Es trägt keine Dolibarr-Kompatibilität, und das mit Absicht: ein Blatt bleibt jahrelang bestehen, jede datierte Angabe darin würde also falsch, ohne dass jemand sie korrigiert.
Das Projektblatt wird über Ihr Konto angelegt oder per API, wenn Sie von einer Integrationskette ausgehen. Ein Artikel kommt ohne Projektblatt aus - dann ist es eine Herausgeberankündigung -, aber eine Versionsveröffentlichung verdient ihr eigenes.
# Créer la fiche
curl -H "Authorization: Bearer $TOKEN" -H "Content-Type: application/json" \
-d '{"editor_id":3,"name":"Mon module",
"summary":"Ce que fait le module, en une phrase.",
"license":"GPL-3.0-or-later"}' \
https://dolinews.com/api/v1/projects
# Ajouter un lien typé : dolistore, shop, demo, doc, repo, support, other
curl -H "Authorization: Bearer $TOKEN" -H "Content-Type: application/json" \
-d '{"type":"repo","url":"https://example.org/mon-module","label":"Dépôt git"}' \
https://dolinews.com/api/v1/projects/mon-module/linksURL-Kürzer werden abgelehnt, und ein bereits von einem anderen Herausgeber beanspruchter Dolistore-Eintrag löst einen Konflikt aus, den die Moderation entscheidet.
6. Ihre Ankündigung einreichen
Über die Website auf der Seite Ihrer Artikel oder über die API. Der Inhalt ist in beiden Fällen derselbe, und die Kurzfassung ist Pflicht: sie ist es, was der Leser im Strom überfliegt, und ihr Fehlen macht die meisten Änderungsprotokolle unlesbar.
- Der Typ unterscheidet die Versionsveröffentlichung von der Herausgeber-Ankündigung; die Art der Veröffentlichung - Sicherheit, Korrektur, Funktion, Kompatibilität, Lebensende - gilt nur für eine Version.
- Die Reife reicht von Alpha bis veraltet. Nur stabile Versionen erscheinen standardmäßig im Strom: den Rest fordert der Leser ausdrücklich an.
- Die Dolibarr-Kompatibilität ist eine Spanne von Hauptversionen und wird entweder schlicht angegeben oder als tatsächlich erprobt. Geben Sie nichts als erprobt an, was Sie nicht ausprobiert haben: der Versionsfilter hängt davon ab.
- Der Text ist Markdown. Ausgehende Links tragen alle nofollow, und nur auf dem Dienst hochgeladene Bilder dürfen einen Artikel bebildern.
Eine bebilderte Ankündigung erscheint in zwei Schritten: die Bilder hochladen, dann den Artikel anlegen und dabei ihre Adressen im Text und ihre Kennungen in media_ids nennen. Ohne diese Kennungen bleiben die Bilder verwaist und werden nach vierundzwanzig Stunden gelöscht.
# 1. Déposer une capture. Elle est ré-encodée, ses métadonnées disparaissent.
curl -H "Authorization: Bearer $TOKEN" \
-F file=@capture.png -F editor_id=3 -F alt="Écran de configuration" \
https://dolinews.com/api/v1/media
# 2. Créer l'article et le soumettre dans le même appel
curl -H "Authorization: Bearer $TOKEN" -H "Content-Type: application/json" \
-d '{"editor_id":3,"project_id":7,"type":"release",
"title":"Mon module 2.1","version":"2.1.0","locale":"fr_FR",
"focus":"bugfix_major","maturity":"stable","dolibarr_min":20,
"summary":"Ce que cette version change, en quelques lignes.",
"body":"## Corrections\n\n",
"media_ids":[42],"submit":true}' \
https://dolinews.com/api/v1/articlesEin Bildschirmfoto eines laufenden Dolibarr enthält fast immer echte Daten - Geschäftspartner, Beträge, Adressen. Säubern Sie es vor dem Hochladen.
Das Titelbild ist das Bild, das der Feed, die Vorschaukarte beim Teilen und die Feeds zu Ihrer Ankündigung zeigen: Legen Sie es mit featured_media_id unter den Bildern Ihres Herausgebers fest, oder mit der Zeile image: im Kopf, wenn Sie das Veröffentlichungswerkzeug nutzen. Es wird mit der Ankündigung geprüft, und eine Änderung nach der Veröffentlichung läuft über eine Revision. Ohne Titelbild wird das erste Bild des Textes gezeigt; eine Übersetzung zeigt das des Originals.
Zwei Grenzen schützen die Warteschlange: ein Veröffentlichungstakt je Projekt und eine Obergrenze gleichzeitig geprüfter Ankündigungen desselben Herausgebers. Eine Ankündigung und ihre Übersetzungen zählen als eine.
7. Die Prüfung und was danach kommt
Ihr Artikel kommt in die Warteschlange, und drei Moderatoren müssen ihn annehmen, damit er erscheint. Der Austausch läuft in einem privaten Strang zwischen Ihnen und dem Team: Sie antworten dort, Sie bessern nach, Sie reichen erneut ein. Einen wartenden Artikel zu ändern eröffnet eine neue Prüfrunde, denn eine Zustimmung gilt einem bestimmten Text.
Es wird keine Dauer zugesagt, und das ist kein Versäumnis: sich über die Freizeit von Freiwilligen zu verpflichten, machte aus jeder Verzögerung einen Verstoß. Die Prüfseite zeigt die tatsächlich beobachtete Dauer und die längste Wartezeit. Eine Sicherheitsankündigung geht vor.
Einmal veröffentlicht, wird ein Artikel nie an Ort und Stelle geändert: Sie schlagen eine Korrektur vor, die erneut die Prüfung durchläuft, der Artikel trägt den Hinweis auf seine Korrektur und die ursprüngliche Fassung bleibt einsehbar. Eine Übersetzung ist ein eigenständiger Artikel, mit ihrem Original verbunden: die von Ihnen selbst eingereichte erscheint ohne Prüfung, die eines von Ihnen beauftragten Übersetzers geht durch einen Prüfer; eine nicht übersetzte Ankündigung wird in der Verbreitung nie benachteiligt.