Skip to content

Commit

Permalink
Merge pull request #102 from mittwald/en-introduction-glossary
Browse files Browse the repository at this point in the history
Translate introduction and glossary
  • Loading branch information
cloudsftp authored Sep 2, 2024
2 parents 48d6d5d + 73bc640 commit a87fbef
Show file tree
Hide file tree
Showing 4 changed files with 77 additions and 20 deletions.
31 changes: 16 additions & 15 deletions docs/contribution/2-glossary.mdx
Original file line number Diff line number Diff line change
@@ -1,35 +1,36 @@
---
title: Glossar
title: Glossary
---

## Contributor

Ausgewählte Organisationen können als `Contributor` Extensions für das mStudio und dessen Benutzer bereitstellen.
Selected organizations can provide extensions of the mStudio to its users as a `Contributor`.

## Extension

Eine `Extension` ist eine Erweiterung des mStudio, die von einem Contributor bereitgestellt wird.
Sie bietet Möglichkeiten, authentifiziert und authorisiert die öffentliche mittwald API zu bedienen.
An `Extension` is an extension of the mStudio, that is provided by the contributor.
It offers ways to interact with the public mittwald API.
These interactions are authenticated and authorized.

## Extension Context

Extensions können entweder zu einem Projekt oder zu einer Organisation hinzugefügt werden.
Dies verallgemeinern wir unter dem Begriff `Extension Context`.
Als Contributor entscheidest du, für welchen Extension Context deine Extension verfügbar sein soll.
Extensions can be added to either a project or an organization.
We generalize this with the term `Extension Context`.
As a contributor, you decide which extension context should be used for your extension.

## Extension Instance

Wenn du eine Extension zu einem Extension Context hinzufügst, wird eine `Extension Instance` erstellt.
Zum Beispiel wird beim Hinzufügen einer Extension zu einem Projekt eine Extension Instance für dieses Projekt erstellt.
Wenn dieselbe Extension zu einem anderen Projekt hinzugefügt wird, wird eine weitere Extension Instance für das zweite Projekt erstellt.
Dies ist wichtig, weil jede Extension Instance ihre eigene ID, Konfiguration, zugestimmte Scopes usw. hat.
When you add an extension to an extension context, an `Extension Instance` is created.
For example, if you add an extension to a project, an extension instance is created for this project.
If the same extension is added to another project, a new extension instance is created for the second project.
This is important since every extension instance has its unique ID, configuration, consented scopes, etc.

## Scope

Ein `Scope` ist ein Satz von Berechtigungen, den eine Extension anfordern kann.
Wenn eine Extension zu einem Extension Context hinzugefügt wird, muss allen angeforderten Scopes zugestimmt werden.
A `Scope` is a set of permissions, an extension can request.
If an extension is added to an extension context, the user has to consent to the requested scopes.

## Domain Action

`Domain Action` ist ein universeller Begriff für einen beliebigen Request, wie z.B. das Erstellen eines neuen Projekts
oder das Einladen eines Benutzers in eine Organisation, der an unsere öffentliche API gestellt wird.
`Domain Action` is a general term for any request sent to the public mittwald API,
such as the creation of a new project or the invitation of a user to an organization.
10 changes: 5 additions & 5 deletions docs/contribution/index.mdx
Original file line number Diff line number Diff line change
@@ -1,21 +1,21 @@
---
title: Einleitung
title: Introduction
sidebar_position: 1
---

## Was heißt es zu "contributen"?
## What does it mean to "contribute"?

TODO

## Warum sollte ich contributen?
## Why should I contribute?

TODO

## Voraussetzungen für die Contribution
## Requirements for contributions

TODO

## Aufbau der Dokumentation
## Structure of this documentation

TODO

Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
title: Glossar
---

## Contributor

Ausgewählte Organisationen können als `Contributor` Extensions für das mStudio und dessen Benutzer bereitstellen.

## Extension

Eine `Extension` ist eine Erweiterung des mStudio, die von einem Contributor bereitgestellt wird.
Sie bietet Möglichkeiten, authentifiziert und authorisiert die öffentliche mittwald API zu bedienen.

## Extension Context

Extensions können entweder zu einem Projekt oder zu einer Organisation hinzugefügt werden.
Dies verallgemeinern wir unter dem Begriff `Extension Context`.
Als Contributor entscheidest du, für welchen Extension Context deine Extension verfügbar sein soll.

## Extension Instance

Wenn du eine Extension zu einem Extension Context hinzufügst, wird eine `Extension Instance` erstellt.
Zum Beispiel wird beim Hinzufügen einer Extension zu einem Projekt eine Extension Instance für dieses Projekt erstellt.
Wenn dieselbe Extension zu einem anderen Projekt hinzugefügt wird, wird eine weitere Extension Instance für das zweite Projekt erstellt.
Dies ist wichtig, weil jede Extension Instance ihre eigene ID, Konfiguration, zugestimmte Scopes usw. hat.

## Scope

Ein `Scope` ist ein Satz von Berechtigungen, den eine Extension anfordern kann.
Wenn eine Extension zu einem Extension Context hinzugefügt wird, muss allen angeforderten Scopes zugestimmt werden.

## Domain Action

`Domain Action` ist ein universeller Begriff für einen beliebigen Request, wie z.B. das Erstellen eines neuen Projekts
oder das Einladen eines Benutzers in eine Organisation, der an unsere öffentliche API gestellt wird.
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
title: Einleitung
sidebar_position: 1
---

## Was heißt es zu "contributen"?

TODO

## Warum sollte ich contributen?

TODO

## Voraussetzungen für die Contribution

TODO

## Aufbau der Dokumentation

TODO

0 comments on commit a87fbef

Please sign in to comment.