diff --git a/docs/maschinenraum.en.md b/docs/maschinenraum.en.md index d73eae855508faaf25d1a92bb5937138736b9b83..916c2924a04c267ccc0c47569647277351d8927f 100644 --- a/docs/maschinenraum.en.md +++ b/docs/maschinenraum.en.md @@ -31,8 +31,8 @@ This menu point allows you to select the assembly representation: * Links: To which Assembly do you have ties (personnel or topical)? Next to whom do you "sit"? * Members: Who's part of your assembly? The role of "offical contact person"(offizieller Ansprechpartner) will be used as such. We'll highlight the person on the website and use them as contact for the orga, for example in abuse cases. The role manager will be displayed as a regular person (should you choose to assign it), but is capable of changing settings of the assembly. And lastly all members may be shown publicly, but don't have to be. * Authentication: - * This is where you can fetch tokens, with which your assembly can for example give badges to users. - * Additionally this is where you can register external applications, that will use [OAuth2](https://oauth.net/2/) -based authentication for conference participants. + * This is where you can fetch tokens, with which your assembly can for example give badges to users. + * Additionally this is where you can register external applications, that will use [OAuth2](https://oauth.net/2/) -based authentication for conference participants. ### How are rooms created? @@ -91,7 +91,7 @@ For example, such a link for an assembly with the slug "ccc" might look like thi You can upload your files with an FTPS-capable programme (e.g. [FileZilla (external link)](https://filezilla-project.org/download.php?show_all=1)). -After the upload, the file can be included in the rc3.world with the link `https://hangar.rc3.world/<username>/<filename>`. +After the upload, the file can be included in the rc3.world with the link `https://hangar.rc3.world/<username>/<filename>`. `<filename>` is the name of the uploaded file. This may contain spaces, but these must be treated accordingly in the link. @@ -126,13 +126,14 @@ Within the Maschinenraum Badges can be directly assigned to users. ##### Create Redeem Tokens When automaticly assigning badges to users, Redeem Tokens (TM) are necessary. There are four types of Redeem Tokens: + * **One-Time**: The token can be used exaclty once. * **Permanent**: The token can be used an unlimited amount of time. * **Map**: The token can be only used in rc3 World Maps. * **Limited**: The token can be used an n amount of time.  - + These can be created via the Maschinenraum (see image) or via API: Just send a REST POST Request to `/api/c/<conference_slug>/assembly/<assembly>/badges/new_redeem_token` with the following body: @@ -150,7 +151,7 @@ _`amount` is only necessary if you create a limited redeem token._ ##### Using Redeem Tokens to get the badge Badges can be distributed via the Redeem Tokens. ###### User adds it via the frontend -A user can go to his profile (`/<conference_slug>/me`) and redeem a token in "My badges". +A user can go to his profile (`/<conference_slug>/me`) and redeem a token in "My badges". A url is available to auto-fill in the token input field: `/<conference_slug>/me/redeem_badge/<redeem_token>`. This is perfect to use it in QR codes. @@ -197,4 +198,3 @@ There is separate documentation for channels and connected questions: [c3voc.de/ In case of questions regarding streams please contact: recommended: IRC, #voc-lounge im Hackint.eu possible: [voc@c3voc.de](mailto:voc@c3voc.de) - diff --git a/docs/maschinenraum.md b/docs/maschinenraum.md index 984a90d34efbc648dd011e238ba8890d72ae754b..2408448db1241c0cb12724dc1c169405be03bd8b 100644 --- a/docs/maschinenraum.md +++ b/docs/maschinenraum.md @@ -20,7 +20,7 @@ Was auch immer in Eurer Assembly passiert: Ihr seid dafür verantwortlich! Desha ## Jetzt zum Maschinenraum -Der Maschinenraum unter https://maschinenraum.rc3.world/ ist zur Verwaltung Eurer Assembly gedacht. Dies ist jedoch nicht das Konferenz-Frontend und Ihr seht auch keine Inhalte anderer Assemblies! +Der Maschinenraum unter [maschinenraum.rc3.world](https://maschinenraum.rc3.world/) ist zur Verwaltung Eurer Assembly gedacht. Dies ist jedoch nicht das Konferenz-Frontend und Ihr seht auch keine Inhalte anderer Assemblies! Den Account, den Ihr hier verwendet, könnt (nicht: müsst) Ihr später für den Zugriff auf die Konferenz-Plattform nutzen, sobald Ihr ein Konferenz-Ticket damit verknüpft habt (dafür kommt aus dem Ticket-Tool zu gegebener Zeit ein entsprechender Link). Zum Login den Nutzernamen (statt eMail) und Passwort aus dem Signup verwenden. @@ -34,8 +34,8 @@ Unter diesem Menüpunkt könnt Ihr anlegen, wie Eure Assembly repräsentiert wir * Links: Zu welchen Assemblies besteht thematische oder personelle Nähe? Neben wem "sitzt" ihr? * Mitglieder: Wer ist bei Eurer Assembly dabei? Die Rolle "offizieller Ansprechpartner" wird als solche benutzt - auf der Webseite wird diese hervorgehoben und dient der Orga als Kontaktperson, z.B. bei Abusefällen. Die Rolle "Manager" wird wie ein reguläres Mitglied angezeigt (sofern überhaupt gewünscht), kann aber Einstellungen an der Assembly vornehmen. Zu guter Letzt können alle Mitglieder öffentlich angezeigt werden oder auch nicht. * Authentifizierung: - * Hier könnt Ihr ein Token anfordern, mit dem Eure Assembly z.B. Badges an Nutzer:innen verteilen kann. - * Zudem können hier externe Anwendungen registriert werden, die dann [OAuth2](https://oauth.net/2/) -basiert eine Authentifizierung von Nutzer:innen der Konferenz anfordern können. + * Hier könnt Ihr ein Token anfordern, mit dem Eure Assembly z.B. Badges an Nutzer:innen verteilen kann. + * Zudem können hier externe Anwendungen registriert werden, die dann [OAuth2](https://oauth.net/2/) -basiert eine Authentifizierung von Nutzer:innen der Konferenz anfordern können. ### Wie werden Räume angelegt? @@ -99,7 +99,7 @@ Beispielsweise könnte ein solcher Link für eine Assembly mit dem slug "ccc" so Eure Dateien könnt ihr mit einem FTPS-fähigen Programm, (z.B. [FileZilla (externer Link)](https://filezilla-project.org/download.php?show_all=1)) hochladen. -Nach dem Upload kann die Datei mit dem Link `https://hangar.rc3.world/<Username>/<filename>` in die rc3.world eingebunden werden. +Nach dem Upload kann die Datei mit dem Link `https://hangar.rc3.world/<Username>/<filename>` in die rc3.world eingebunden werden. `<filename>` ist dabei der Name der hochgeladenen Datei. Diese darf zwar Leerzeichen enthalten, diese müssen dann aber im Link entsprechend behandelt werden. @@ -133,13 +133,14 @@ Im Maschinenraum können Badges direkt an User vergeben werden. ##### Erstellung von Redeem Tokens Zum sonstigen Vergeben von Badges wind Redeem Tokens (TM) notwending. Es gibt vier verschiedene Klassen: + * **One-Time**: Dieses Token ist exakt einmal einlösbar. * **Permanent**: Dieses Token ist unendlich oft einlösbar. * **Map**: Dieses Token ist kann nur in rc3.World maps eingelöst werden. * **Limited**: Dieses Token ist exakt n-mal einlösbar.  - + Diese Redeem Tokens können im Maschinenraum (siehe Bild) oder per API erstellt werden: @@ -158,7 +159,7 @@ _`amount` ist nur notwending, wenn Ihr ein Limited Redeem Token erstellen wollt. ##### Redeem Tokens einlösen Mit Redeem Tokens können Badges verteilt werden. -###### User löst es im Frontend ein +###### User löst es im Frontend ein Ein Benutzer kann ein Redeem Token in seinem Profil (`/<conference_slug>/me`) einlösen unter "Meine Badges". Eine URL zum automatischen ausfüllen von diesem Feld (z.B. für QR Codes) wird bereitgestellt: `/<conference_slug>/me/redeem_badge/<redeem_token>`. @@ -171,7 +172,7 @@ Wenn ein Benutzer einen Badge im Frontend in seinem Profil einlöst, wird dieser Es wird eine API bereitgestellt, mit der Badges einem Benutzer zugewiesen wrden können. Diese Badges müssen vom Benutzer manuell akzeptiert werden (`/<conference_slug>/me/manage_badges`). -REST POST Request: `/api/c/<conference_slug>/badges/redeem_token` +REST POST Request: `/api/c/<conference_slug>/badges/redeem_token` Body: ```