Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add description of extension lifecycle #387

Open
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

tdellmann
Copy link
Contributor

No description provided.

…-overview/1-extensions.mdx

Co-authored-by: Ali Nazeri <[email protected]>
Signed-off-by: tdellmann <[email protected]>
Copy link
Member

@martin-helmich martin-helmich left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please mind spelling and punctuation (in both languages) in general. This is also something that AI tools should be good at.

docs/contribution/30-overview/1-extensions.mdx Outdated Show resolved Hide resolved
docs/contribution/30-overview/1-extensions.mdx Outdated Show resolved Hide resolved
docs/contribution/30-overview/1-extensions.mdx Outdated Show resolved Hide resolved
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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is inconsistent with the german translation ("Die Löschung der Extension passiert asynchron, weil alle Extension-Instances vorab gelöscht werden.").

The original sentence ("must be removed") implies that some kind of action is required (either from the contributor, or from the extension users) to remove existing extension instances, whereas the passive phrasing in the german version implies that this is done by the system.

Which is it?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the german version is correct. That concept changed while this was worked on.
I'm going to correct this.

@@ -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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I get that this is a high-level description of the whole process; but is there a more detailed description of the whole process (including API calls and such) somewhere that we can link here?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

not yet, unfortunately.

The routes are currently beeing beautified before we publish them.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants