Einleitung

Einführung in das Contribution-Konzept

Extensions sind der ideale Weg, das mStudio um Funktionen zu erweitern.

Eine Extension ist eine von einem Contributor herausgegebene Web-Anwendung, die im mStudios für die mStudio Benutzer bereitgestellt wird und von einem berechtigten mStudio Benutzer bei Bedarf zu einem Projekt oder einer Orginasation hinzugefügt werden kann.

Der Inhalt bzw. die Funktion der Extension soll dem mStudio Benutzer Mehrwert für seine tägliche Arbeit bei der Verwaltung, Erstellung und Bearbeitung seiner Web-Projekte bieten und mit der Lösung den Funktionsumfang des mStudio erweitern.

Aus technischer Sicht ist eine Extension eine separate und unabhängige Applikation, die über REST-APIs mit dem mStudio integriert wird. Eine Extension muss ein öffentlich erreichbares Backend bereitstellen und kann optional ein Frontend bereitstellen, wenn es für die Nutzung der Extension sinnvoll ist. Wenn Extension Instances beispielsweise erstellt oder gelöscht werden, benachrichtigt das mStudio das Backend der Extension über einen Lifecycle Webhook.

Extensions können...

... den eigenen Workflow im Umgang mit dem mStudio vereinfachen und beschleunigen und somit die Produktivität steigern.

... genutzt werden um Informationen auszulesen, Ressourcen zu erstellen oder zu bearbeiten oder um Workflows zu automatisieren.

... sich authentifiziert und autorisiert an der öffentlichen mittwald API bedienen.

... genutzt werden um automatisierte Deployment-Strategien über CI/CD-Pipelines von Drittanbietern zu implementieren.

... dazu verwendet werden, bestehende Drittanbieter Produkte oder Dienstleistungen in das mStudio zu integrieren und somit tausenden Organisationen zur Verfügung gestellt werden.

... dazu genutzt werden, alternative Geschäftsmodelle zu realisieren.

Von der Idee zur Veröffentlichung:

Idee entwickeln: Du hast bereits selbst ein Problem identifiziert, welches du schon immer lösen wolltest? Super! Dann los gehts! Selbst wenn du noch unsicher bist, melde dich bei uns (per E-Mail an: contributorwerden@mittwald.de). Wir überlegen gemeinsam, was dir fehlt und wie wir dich unterstützen können.

Contributor werden: Schreibe eine E-Mail an contributorwerden@mittwald.de. Lass uns gemeinsam Fragen klären und die nächsten Schritte besprechen. Anschließend wirst du als Contributor gelistet und kannst damit loslegen.

Entwickeln: Jetzt gehts los! In dieser Dokumentation findest du Hinweise, Tools, Vorlagen, Beispiele etc., die dich dabei unterstützen.

Im Austausch mit mittwald: Du hast Fragen? Dir fehlen Funktionen? Wir begleiten dich! Du erhältst Zugang zum privaten GitHub-Repository, in dem du dich mit uns und allen anderen Contributoren austauschen kannst. Gern bringen wir dich auch mit unseren Fachleuten direkt zusammen, so dass du im Flow bleibst.

Extension veröffentlichen: Fertig entwickelt? Dann veröffentliche deine Extension! Wir brauchen nur eine YAML-Datei von dir. Wir prüfen einmal den Inhalt deiner Extension. Anschließend geht sie Live und tausende Kunden können Sie hinzufügen.

Geld verdienen Du legst fest, ob und wie viel Geld deine Extension monatlich kosten soll. 85% der Verkaufserlöse wandern in deine Tasche. 15% behalten wir als Verkaufsprovision ein. Zusätzlich übernehmen wir den ganzen Abrechnungsaufwand. Wir erstellen die Rechnungen für den Kunden und kümmern uns auch um die Abrechnung deiner Verkaufserlöse.

Kunden supporten Bei Fragen zu deiner Extension wird der Kunde sich direkt an dich wenden. Aktuell ist die Kommunikation per E-Mail organisiert. Wir wollen zukünftig auch ein Supportportal anbieten.

Weiterentwicklung Entwickle deine Extension in die Richtung und in dem Tempo, wie du willst!

Freuen Ein Problem, was du schon lange gelöst haben wolltest, ist erledigt! Du hilfst anderen Agenturen, die vor der selben Problematik stehen und verdienst noch Geld dabei! Worauf wartest du noch?

Warum sollte ich contributen?

Wenn du deine Extension im mStudio bereitstellst, kannst du die Community unterstützen und gleichzeitig regelmäßige Einnahmen generieren.

• Du kannst flexibel auf die Anforderungen in deinem Agenturalltag reagieren und deine Extension jederzeit anpassen. Dir fehlt etwas? Dann baue es so, wie du es benötigst.
• Die Extension wird in deinem Namen veröffentlicht. Damit hast du die Möglichkeit, deinen Kundenstamm zu erweitern. Bereits heute verwalten mehrere Tausend Organisationen und ihre User Ihre Webprojekte im mStudio. Alle mStudio-Benutzer können deine Extension sehen, benutzen und finden dich und dein Unternehmen.
• Extensions von Agenturen, für Agenturen. Du kannst mit deiner Lösung die ganze Branche voranbringen, denn 90% der Webprojekte, die bei mittwald gehostet werden, werden von Agenturen betreut.
• Laufende Einnahmen! Du legst den monatlichen Preis für deine Extension selbst fest! 85% der Erlöse wandern direkt in deine Tasche!
• Einfache Abrechnung: mittwald übernimmt die Abrechnung für dich! Wir rechnen mit dem Endkunden ab und übernehmen auch die Abrechnung für deine Vergütung. Somit kannst du deinen Fokus auf die Entwicklung deiner Extension legen!
• Einfache Entwicklung: Wir unterstützen dich mit einer standardisierten API, OAuth, und stellen dir Frontend-Komponenten und Beispiel-Extensions bereit. Bei Fragen und Problemen sind wir in alter mittwald-Manier jederzeit erreichbar.

Voraussetzungen für die Contribution

Um selbst eine Extension im mStudio bereitzustellen, benötigst du Folgendes:

• Einen mStudio-Benutzer und eine Organisation im mStudio, über die du die Extension bereitstellen möchtest. Die Anlage von beidem wird im Abschnitt Organisation im mStudio anlegen erklärt.
• Listung als Contributor bei mittwald. Wie das funktioniert, kannst du im Abschnitt Als Contributor listen nachlesen.
• Eine Support-E-Mailadresse, über die dich deine Kunden erreichen können.

Aufbau der Dokumentation

Diese Dokumentation wird dich dabei begleiten, die grundlegenden Entwicklungskonzepte der Extension-Entwicklung zu verstehen. Zusammen mit deiner Erfahrung als Entwickler und deiner Idee für eine eigene Extension sollst du anschließend in der Lage sein, eine eigene Extension zu entwickeln und sie im mStudio bereitzustellen.

Neben den technischen Inhalten sind in dieser Dokumentation auch die grunlegenden organisatorischen Prozesse beschrieben. Du findest Informationen zur Austauschplattform zwischen mittwald und den Contributoren, über den Supportweg für den Endkunden und die Abrechnung für deine Extension.

Im Glossar findest du Begriffsdefinitionen.

Im Abschnitt Überblick wird grundlegendes Wissen vermittelt.

Im Abschnitt How to werden häufig gestellte Fragen erklärt.

Im Abschnitt Referenzen werden technische Konzepte mit Schema-Dokumentationen, Templates, Tipps zur Umsetzung und Erläuterungen vertieft.

Die Möglichkeit, als externer Contributor Extensions zu entwicklen ist für mittwald neu. Wir arbeiten aktiv an diesem Konzept, daher wird auch die Dokumentation regelmäßig erweitert. Wenn dir irgendetwas in der Doku fehlt, nutze gern oben rechts die Funktion, uns über GitHub zu kontaktieren. Wir sind sehr dankbar darüber!