From cb6efdff68f76eabf37a2755a0481cc733dd7e08 Mon Sep 17 00:00:00 2001 From: tdellmann Date: Thu, 16 Jan 2025 15:02:32 +0100 Subject: [PATCH 1/4] add description of extension lifecycle --- .../contribution/30-overview/1-extensions.mdx | 42 +++++++++++++++++++ .../contribution/30-overview/1-extensions.mdx | 42 +++++++++++++++++++ 2 files changed, 84 insertions(+) diff --git a/docs/contribution/30-overview/1-extensions.mdx b/docs/contribution/30-overview/1-extensions.mdx index 159d13ad..a1db24ad 100644 --- a/docs/contribution/30-overview/1-extensions.mdx +++ b/docs/contribution/30-overview/1-extensions.mdx @@ -77,6 +77,48 @@ Optionally, an extension may define an external frontend that functions as an en You configure the external frontend as a URL, for which you may use templating. For more information, see [templating of configuration values](../concepts/templating) and [lifecycle webhook concept](../concepts/lifecycle-webhooks). +## Lifecycle of an Extension + +After registering an Extension the verification can be requested. +To do so a unique name has to be set. +Also the scopes, context and support-information have to be set. +If your extension is not free the webhookUrls are also required. + +The verification can be aborted by the contributor. + +The extension will now be reviewed by mittwald and verified. +If everything checks out and no feedback is provided the extension can be published. +Only the contributor can publish the extension. + +### After Publication + +The extension can be withdrawn again by the contributor. +This prevents new ExtensionInstances from beeing created and disables already existing instances. +This can be useful for performing maintenance. +Afterwards the Extension can be published again without requesting a new verification. + +### Changing the Extension + +Changes of the scopes or the webhookUrls need to be verified by mittwald. +After these changes have been accepted the changes apply instantly. + +The context of an extension can only be changed before the initial verification has been requested. +During the development of the extension the context can be changed freely. +This will remove all extension-instances. + +### When can extension instances be added to a context + +At least the context has to be set to add an extension to a context. +Before the publishing of an extension only the contributor can create instances in their own organization or projects. +Afterward everyone can create extension-instances. + +### Deletion of an Extension + +A graceful deletion of the extension can be realized through defining a deprecation. +The Deprecation defines a shut down date as well as a successor. + +The deletion of the Extension is asynchronous because all Extension-Instances must be removed beforehand. + ## Versioning of Extensions The mStudio does not provide a concept for the versioning of extensions. diff --git a/i18n/de/docusaurus-plugin-content-docs/current/contribution/30-overview/1-extensions.mdx b/i18n/de/docusaurus-plugin-content-docs/current/contribution/30-overview/1-extensions.mdx index 549ffb7b..7c6bb778 100644 --- a/i18n/de/docusaurus-plugin-content-docs/current/contribution/30-overview/1-extensions.mdx +++ b/i18n/de/docusaurus-plugin-content-docs/current/contribution/30-overview/1-extensions.mdx @@ -80,6 +80,48 @@ Das externe Frontend wird als URL angegeben und kann getemplated werden. Siehe dazu auch [Templating von Konfigurationswerten](../concepts/templating). Für weitere Informationen zum External Frontend siehe [External Frontend Konzept](../concepts/external-frontend). +## Lebenszyklus einer Extension + +Nachdem eine Extension registriert wurde kann die Verifizierung beantragt werden. +Dafür muss ein einzigartiger Name gesetzt sein. +Die Scopes, der Kontexts sowie Support-Informationen müssen ebenfalls gesetzt sein. +Wenn die Extension nicht kostenlos angeboten werden soll werden zudem WebhookURLs benötigt. + +Die Verifizierung kann wieder vom Contributor abgebrochen werden. + +Die Extension wird nun von mittwald geprüft und im Anschluss zur veröffentlichung freigegeben. +Nur ein Contributor kann eine Extension veröffentlichen. + +### Nach der Veröffentlichung + +Nach der Veröffentlichung kann eine Extension wieder zurück gezogen werden. +Dadurch werden die bestehenden Instances der Extension deaktiviert. +Dies kann nützlich sein um Wartungen durch zu führen. + +Die Extension kann ohne erneute Verifizierung wieder veröffentlicht werden. + +### Änderungen an der Extension + +Änderungen an den Scopes und den WebhookURLs bedürfen einer erneuten Verifizierung durch mittwald. +Mit der Bestätigung dieser Änderungen werden sie automatisch angewendet. + +Der Context einer Extension kann nach dem Anfragen der Verifizierung nicht mehr geändert werden. +Während der Entwicklung der Extension kann der Context frei geändert werden. +Dabei werden alle Extension-Instances gelöscht. + +### Wann kann wer die Extension zu einem Context hinzufügen? + +Es muss mindestens der Context einer Extension gesetzt sein. +Vor der Veröffentlichung kann die Extension nur zu Kontexten des Kontributors selbst hinzugefügt werden. +Danach kann jeder die Extension zu Kontexten hinzufügen. + +### Löschung der Extension + +Um eine Extension schonend zu löschen kann eine Deprecation phase definiert werden. +Hier kann ein Enddatum und ein Nachfolger für die extension gewählt werden. + +Die löschung der Extension passiert asynchron, weil alle Extension-Instances vorab gelöscht werden. + ## Versionierung von Extensions Das mStudio sieht kein Konzept für die Versionierung von Extensions vor. From f13665517bb6cac240b1c7bd7f5faeda3bbb69f0 Mon Sep 17 00:00:00 2001 From: tdellmann Date: Tue, 21 Jan 2025 13:49:30 +0100 Subject: [PATCH 2/4] Update i18n/de/docusaurus-plugin-content-docs/current/contribution/30-overview/1-extensions.mdx Co-authored-by: Ali Nazeri Signed-off-by: tdellmann --- .../current/contribution/30-overview/1-extensions.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/i18n/de/docusaurus-plugin-content-docs/current/contribution/30-overview/1-extensions.mdx b/i18n/de/docusaurus-plugin-content-docs/current/contribution/30-overview/1-extensions.mdx index 7c6bb778..afb04a4b 100644 --- a/i18n/de/docusaurus-plugin-content-docs/current/contribution/30-overview/1-extensions.mdx +++ b/i18n/de/docusaurus-plugin-content-docs/current/contribution/30-overview/1-extensions.mdx @@ -117,7 +117,7 @@ Danach kann jeder die Extension zu Kontexten hinzufügen. ### Löschung der Extension -Um eine Extension schonend zu löschen kann eine Deprecation phase definiert werden. +Um eine Extension schonend zu löschen kann eine Deprecation-Phase definiert werden. Hier kann ein Enddatum und ein Nachfolger für die extension gewählt werden. Die löschung der Extension passiert asynchron, weil alle Extension-Instances vorab gelöscht werden. From 6bb3e128fa763fd14c15a842f0758b817f721a30 Mon Sep 17 00:00:00 2001 From: tdellmann Date: Wed, 22 Jan 2025 11:23:04 +0100 Subject: [PATCH 3/4] Apply suggestions from code review Co-authored-by: Martin Helmich Signed-off-by: tdellmann --- docs/contribution/30-overview/1-extensions.mdx | 8 ++++---- .../contribution/30-overview/1-extensions.mdx | 18 +++++++++--------- 2 files changed, 13 insertions(+), 13 deletions(-) diff --git a/docs/contribution/30-overview/1-extensions.mdx b/docs/contribution/30-overview/1-extensions.mdx index a1db24ad..1478ad35 100644 --- a/docs/contribution/30-overview/1-extensions.mdx +++ b/docs/contribution/30-overview/1-extensions.mdx @@ -81,26 +81,26 @@ For more information, see [templating of configuration values](../concepts/templ After registering an Extension the verification can be requested. To do so a unique name has to be set. -Also the scopes, context and support-information have to be set. +Also the scopes, context and support contact information have to be set. If your extension is not free the webhookUrls are also required. The verification can be aborted by the contributor. -The extension will now be reviewed by mittwald and verified. +The extension will now be reviewed and verified by mittwald. If everything checks out and no feedback is provided the extension can be published. Only the contributor can publish the extension. ### After Publication The extension can be withdrawn again by the contributor. -This prevents new ExtensionInstances from beeing created and disables already existing instances. +This prevents new ExtensionInstances from being created and disables already existing instances. This can be useful for performing maintenance. Afterwards the Extension can be published again without requesting a new verification. ### Changing the Extension Changes of the scopes or the webhookUrls need to be verified by mittwald. -After these changes have been accepted the changes apply instantly. +After these changes have been accepted, the changes apply instantly. The context of an extension can only be changed before the initial verification has been requested. During the development of the extension the context can be changed freely. diff --git a/i18n/de/docusaurus-plugin-content-docs/current/contribution/30-overview/1-extensions.mdx b/i18n/de/docusaurus-plugin-content-docs/current/contribution/30-overview/1-extensions.mdx index afb04a4b..dd4e1bab 100644 --- a/i18n/de/docusaurus-plugin-content-docs/current/contribution/30-overview/1-extensions.mdx +++ b/i18n/de/docusaurus-plugin-content-docs/current/contribution/30-overview/1-extensions.mdx @@ -82,27 +82,27 @@ Für weitere Informationen zum External Frontend siehe [External Frontend Konzep ## Lebenszyklus einer Extension -Nachdem eine Extension registriert wurde kann die Verifizierung beantragt werden. +Nachdem eine Extension registriert wurde, kann die Verifizierung beantragt werden. Dafür muss ein einzigartiger Name gesetzt sein. -Die Scopes, der Kontexts sowie Support-Informationen müssen ebenfalls gesetzt sein. -Wenn die Extension nicht kostenlos angeboten werden soll werden zudem WebhookURLs benötigt. +Die Scopes, der Kontext sowie Support-Kontaktdaten müssen ebenfalls gesetzt sein. +Wenn die Extension nicht kostenlos angeboten werden soll, werden zudem Webhook-URLs benötigt. Die Verifizierung kann wieder vom Contributor abgebrochen werden. -Die Extension wird nun von mittwald geprüft und im Anschluss zur veröffentlichung freigegeben. +Die Extension wird nun von mittwald geprüft und im Anschluss zur Veröffentlichung freigegeben. Nur ein Contributor kann eine Extension veröffentlichen. ### Nach der Veröffentlichung Nach der Veröffentlichung kann eine Extension wieder zurück gezogen werden. Dadurch werden die bestehenden Instances der Extension deaktiviert. -Dies kann nützlich sein um Wartungen durch zu führen. +Dies kann nützlich sein, um Wartungen durchzuführen. Die Extension kann ohne erneute Verifizierung wieder veröffentlicht werden. ### Änderungen an der Extension -Änderungen an den Scopes und den WebhookURLs bedürfen einer erneuten Verifizierung durch mittwald. +Änderungen an den Scopes und den Webhook-URLs bedürfen einer erneuten Verifizierung durch mittwald. Mit der Bestätigung dieser Änderungen werden sie automatisch angewendet. Der Context einer Extension kann nach dem Anfragen der Verifizierung nicht mehr geändert werden. @@ -117,10 +117,10 @@ Danach kann jeder die Extension zu Kontexten hinzufügen. ### Löschung der Extension -Um eine Extension schonend zu löschen kann eine Deprecation-Phase definiert werden. -Hier kann ein Enddatum und ein Nachfolger für die extension gewählt werden. +Um eine Extension schonend zu löschen, kann eine Deprecation-Phase definiert werden. +Hier kann ein Enddatum und ein Nachfolger für die Extension gewählt werden. -Die löschung der Extension passiert asynchron, weil alle Extension-Instances vorab gelöscht werden. +Die Löschung der Extension passiert asynchron, weil alle Extension-Instances vorab gelöscht werden. ## Versionierung von Extensions From 7e276468ca7f3df3f3adb5c42298d9e80274bac5 Mon Sep 17 00:00:00 2001 From: tdellmann Date: Wed, 22 Jan 2025 11:30:42 +0100 Subject: [PATCH 4/4] correct english description of deletion process --- docs/contribution/30-overview/1-extensions.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/contribution/30-overview/1-extensions.mdx b/docs/contribution/30-overview/1-extensions.mdx index 1478ad35..ba964e05 100644 --- a/docs/contribution/30-overview/1-extensions.mdx +++ b/docs/contribution/30-overview/1-extensions.mdx @@ -117,7 +117,7 @@ Afterward everyone can create extension-instances. A graceful deletion of the extension can be realized through defining a deprecation. The Deprecation defines a shut down date as well as a successor. -The deletion of the Extension is asynchronous because all Extension-Instances must be removed beforehand. +The extension is deleted asynchronously because all extension instances are deleted beforehand. ## Versioning of Extensions