From 6efd3b542d4ee38f74c9d18982c3ed11704c3d31 Mon Sep 17 00:00:00 2001
From: TRim <t.rimmele@posteo.de>
Date: Tue, 28 Dec 2021 11:18:07 +0000
Subject: [PATCH] Update maschinenraum.en.md
---
docs/maschinenraum.en.md | 119 +++++++++++++++++----------------------
1 file changed, 52 insertions(+), 67 deletions(-)
diff --git a/docs/maschinenraum.en.md b/docs/maschinenraum.en.md
index 916c292..05ef200 100644
--- a/docs/maschinenraum.en.md
+++ b/docs/maschinenraum.en.md
@@ -1,99 +1,82 @@
How to Maschinenraum
===
-This documentation is aimed at assemblies and describes how you can manage your assembly and content in the maschienenraum (engine room).
+This documentation is aimed at assemblies and describes how you can manage your assembly and content in the Maschinenraum (engine room).
-The software is designed to also work with future events with physical attendance, as well as mixed events. This is why it also has options to create physical rooms. For RC3 the digital features will be the solely relevant for the most of you.
+The software is designed to also work with future events with physical attendance, as well as mixed events. Therefore it has options to create physical rooms as well. However for the most of you at rC3 only the digital features are relevant.
## Important Infos
Legal entity for abuse reports is the CCCV GmbH.
-All links that point into the internet, are not whitelisted and will be guarded by a dereferer notice. The notice will highlight that this link is outside our domain and hence the operator of said service is responsible for it.
+All links pointing into the internet, are not whitelisted and will trigger a dereferer notice. The notice will highlight that this link is outside our domain and hence the operator of said service is responsible for it.
-You are responsible for your assemblies and any content in them. Any abusive content will be deleted without warning.
+You are responsible for your assemblies and any content within its realm. Any abusive content will be deleted without warning.
-Hosting: Should you want to run services, please host them yourself. If this is not possible, use services that are located in the EU. The use of US Providers is not acceptable, should you want to incorporate them into RC3. We reserve the right to remove/ignore these links, since US data protection is not up to our standards.
+Hosting: If you want to run your own services for the rC3, please host them yourself. If you use a service, it has to be based in the EU. Using US-based providers is not acceptable if you want your content to flow into the rC3. We reserve the right to ignore these links or delete them from the engine room immediately. These services are not compatible with our privacy policy.
-What ever happens in your assembly is your responsibility. There for please remember to amend you imprint and privacy notice.
+Whatever happens in your assembly: You are responsible for it! Therefore remember to add imprint and privacy statements to your own pages.
## Maschinenraum
-For you to administrate your assembly we've setup the Maschienenraum under [maschinenraum.rc3.world](https://maschinenraum.rc3.world/). This how ever is not the conference front-end and you will not see content of other assemblies.
+The engine room at [engineroom.rc3.world](https://maschinenraum.rc3.world/) is for managing your assembly. This is not the conference frontend and you will not see the content of other assemblies!
-The account in use for this, may later be used for the conference platform, once a conference ticket has been linked to it. ( To do so we will provide a link through the ticket tool at a later time.) To log in please use your username (not email address) and password from signup.
+The account you use here can (not: must) be used later to access the conference platform, as soon as you have linked a conference ticket to it (a link for this will come from the ticket tool in due time). For login you use username (instead of eMail) and password from the signup.
-Upon creation, your assembly will pick an abbreviated name (used in URLs), as well as a spoken name. Once thats done we continue in a bigger menu:
+When you create your assembly, it will get a short name (slug), which we use in URLs, and a descriptive name - after that it will go on in a bigger menu:
### Organisational Data
-This menu point allows you to select the assembly representation:
+Under this menu item you can define how your assembly is represented:
-* Basic data: Whats your name? What do you do? Do you habe a logo or website? Also add tags for the search! Here you can upload your frontend page banner. The page will be about 1200px wide, but will be scaled responsive. 16:9 will be a format that might fit match best, but you are free on that. Banner immages shouldn't be larger than 2000x2000px.
-* 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.
+* Basic data: What's your name? What do you do? Do you habe a logo or website? Enter tags for the search! You can also upload a banner for your page in the frontend. The page is about 1200px wide, but will be scaled responsive. A format of 16:9 makes sense, but you are basically free. Banners should not have more than 2000x2000px.
+* Links: To which assemblies is do you have thematic or personal ties? Next to which can you be placed?
+* Members: Who's part of your assembly? The role of "offical contact person"(offizieller Ansprechperson) 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. Last but not least, all members can be displayed publicly or not.
+
+### Authentication:
+* Here you can request a token that your assembly can use to distribute badges to users, for example.
+* In addition, external applications can be registered here, which can then request [OAuth2](https://oauth.net/2/) -based authentication from users of the conference.
### How are rooms created?
-Rooms are modeled after the real world (see intro). Then can ether be created for the PlainUI, or for the 2D world. The options differ.
+Rooms are based on the physical world (see intro). They can be created for the conference website (internally also called 'Plain UI') as well as for the 2D world, although there are differences.
-The 2D-world is not barrier-free, therefore you have the possibility to create barrier-free PlainUI BBB-rooms for self organized sessions, as well as spontaneous "fireside chats".
+Unfortunately, the 2D-world is not barrier-free, therefore you have the possibility to create barrier-free PlainUI BBB-rooms for Self Organised Sessions or "campfires" for spontaneous gatherings, relaxed chatting and socializing in the barrier-reduced conference website.
To create a room, enter name, type of room and capacity.
-If you're planning a lecture hall, workshop room or stage, please remember that conference rooms online don't scale indefinitely. There have been BBB rooms with aprox. 90 participants. This works if people only unmute if necessary and only the speakers turn on their cameras.
+If you're planning a lecture hall, workshop room or stage, please keep in mind that online conference rooms don't scale indefinitely. There have been BBB rooms with about 90 participants. This only works if participants stay muted when silent and as few as possible activate cameras (e.g. only the speakers).
### Contributing a map to the 2D world
-To add a map to the 2D world, you have to offer a cloneable git repo. If the repo is private, you'll have to add deploy tokens in the URL, e.g. https://bernd:brot@git.kinderkanal.de/bluemchenwiese.git.
+To add a map to the 2D world, you need to specify a Git repo that is clonebar. If the repo is private, you'll have to add deploy tokens in the URL, e.g. https://bernd:brot@git.kinderkanal.de/bluemchenwiese.git.
+
+You can read a "How to create a compatible map" in the [rC3-World HowTo](https://howto.rc3.world/).
-Learn how to create a compatible map in the rC3-World HowTo: [howto.rc3.world](https://howto.rc3.world/)
+Your map will be checked automatically by a linter if you have specified the repo.
+* If you get an "error", your map will not go online. You most likely have not fulfilled important requirements. You will find corresponding hints in the engine room.
+* If a warning is displayed, your map will go online. There are hints with potential for improvement.
-### What shall projects actually be?
-Everything you would like to share with the world.
-Flying mate crates, cocktail robots, waffles of mass destruction? Show us and the world!
+### What should projects actually be?
+Anything you'd like to share with the world.
+
+Flying mate-box, cocktail robots, waffles of mass destruction? Show us and the world!
### How are projects created?
-We want to see your projects! To see them in the frontend, we'll need from you:
+We want to see your projects! In order for the good stuff to end up in the frontend, we need from you:
* Project name
-* Description: The flavor text for the info page of your project in the frontend. What's shown? Why would no one want to miss it? Where did the idea come from? Who made this?
+* Description: The flavor text for the info page of your projects in the frontend. What will be shown? Why do beings not want to miss it? Where did the idea come from? Who made it?
* Also: We're still searching people for xyz
* Links to other contents (through deferrer) possible, like a gallery or source code repos, ...
### External links
-Of course you add links for example to the wikis for your projects, however a deferrer warning will be added for everything that is outside of rC3-Domains (e.g. YOLO-land).
+Of course you can link e.g. wikis of your projects. However, anything outside of the rC3 domains is "YOLO land" and will come with a dereferrer warning.
### External media and streams
-External streams from YOLO-land have several downsides (GEMA, abuse, security, ...), which is why we're not integrating those in the world and plainUI, but instead link out to your own sites. This means users will be accessing your own infrastructure via a deferrer.
-If you want to add audio and video in the rC3 (for example on your map), you have the option to store a small amount of data (aprox. 200MB) in the "hangar" (see below). This can then be integrated in your 2D world and onto your project sites.
-
-### How are events with schedule entry created?
-You can offer lectures and sessions as part of your assembly that will show up in the schedule (a little bit apart from the official program), somewhere between an official lecture and a self-organised session.
-A location is not compulsory (yet useful so people know where to go)
-
-### What is the "hangar" in the back office/Maschinenraum?
-You're reserving a "hangar" space, which is then assigned to you. You can imagine it like a virtual storage room for assemblies to embed static content like short videos and loops, audio, etc. in the world.
-This is NOT meant as a file share, don't use it for hosting any kind of online-presence (you wouldn't put a whole armada of planes in a tiny hangar).
-When you're uploading data to the "hangar" please make sure you have the rights to the uploaded data. Violations will lead to the exclusion of the assembly from the whole event.
-
-You can create the hangar as a room in the [Maschinenraum](https://maschinenraum.rc3.world). To do this, click on the "+" next to the menu item "Rooms". In the overview that opens is an option at the top right to set up the hangar. There is only one hangar per assembly. Further setup is not required. Creating the hangar can take up to 15 minutes.
-
-After the hangar has been created, you will find an ftps link of the following form in the "Hangar Access" field in the created room:<br>
-`ftps://<username>:<password>@<server>/`
+External streams from YOLO-land have several downsides (GEMA, abuse, security, ...), which is why we don't embed them in the world or in the conference website, but link out to your own pages. That means, users will get to your own infrastructure via a dereferrer.
-`<username>` is the slug of your assembly (see also under "Organisational Data" / "Basic Data")<br>
-`<password>` is your automatically generated FTP password.<br>
-`<server>` is the FTP server on which the upload takes place.<br>
-
-For example, such a link for an assembly with the slug "ccc" might look like this:<br>
-`ftps://ccc:12345+ab1c@upload.hangar.rc3.world/`
-
-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>`.
-
-`<filename>` is the name of the uploaded file. This may contain spaces, but these must be treated accordingly in the link.
+### How to create events with a timetable entry?
+You can create lectures and sessions as part of your assembly, which will then also appear in the timetable in the frontend (somewhat separated from the official program) - as something in between an official lecture and an independent self-organized session.
+A room reference is not necessary (but somehow useful, because otherwise nobody knows where to go).
+To create a session, click on the plus and enter the relevant information. If you select one of your BBB rooms for such a session, all assembly members with moderation rights will join.
### What are badges and how to create them?
Badges should strengthen the event's explorative character: Assemblies can distribute these stickers/awards for "been there", "discovered something" or maybe also "P=NP proven"...
@@ -108,29 +91,29 @@ Badges need:
* A picture: we recommend PNG, 512x512px
* Select: sticker or achievement mode
-Badges are distributed to users via token. A matching token can be generated when generating the badge.
+Badges are distributed to users via token. A suitable token can be generated when generating the badge.
-* Stickermode: click to enable the stickermode. Imagine it similar to the sticker boxes that assemblies at C3 would put up.
+* Stickermode: Click on it, I want to have it, done. Think of it like the sticker boxes you had with your physical assemblies.
* Achievement
* Mode 1 (anonymous/ user not known): The assemblies gets a redeem token for the user, then they get the token and the profile with the input box opens (similar to found easter eggs). Redeem the redeem code in your profile to unlock the achievement and get the badge.
* Mode 2 (user / SSO known): The assembly hands out the badge to the user. The user has to accept the badge to receive it.
-Users will find collected badges in their profile. Users will always have to actively accept a badge - who wants to suddenly find a pink dolphine vibrator in their profile?
+Collected badges can be found in the user's profile. You always have to actively confirm the receipt of the badges - not everyone wants to suddenly find a pink dolphin vibrator in the profile...
##### Assign directly via Maschinenraum
-Within the Maschinenraum Badges can be directly assigned to users.
+Within the Maschinenraum Badges can be assigned directly to users.
##### Create Redeem Tokens
-When automaticly assigning badges to users, Redeem Tokens (TM) are necessary. There are four types of Redeem Tokens:
+Redeem Tokens (TM) are required to otherwise award badges. There are four different classes:
-* **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.
+* **One-Time**: This token is redeemable exactly once.
+* **Permanent**: This token is redeemable an infinite number of times.
+* **Map**: This token can only be redeemed in rc3.World-maps.
+* **Limited**: This token is redeemable exactly n times.
@@ -150,6 +133,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".
@@ -172,8 +156,8 @@ Just send a REST POST Request to `/api/c/<conference_slug>/badges/redeem_token`
}
```
-##### Using the rc3.world map to assign badges
-In the rc3.world map a tile can be linked to assigning a badge. It works simiar to opening a website, but using the `getBadge` property instead. Usage of **Map** Redeem Tokens is required.
+##### Assigning badges via rc3.world
+In the rc3.world-map a tile can be linked to a badge. When users enter this part, they automatically get the badge assigned. It works similar to opening a website, for this the `getBadge` property is used. You have to use **Map** Redeem Tokens.
@@ -187,7 +171,8 @@ The API always answaers the following when a badge is sucessfully assigned:
}
```
-
+### Assembly status
+In the machine room, you will find a box at the top right of your assembly page that displays the status of your assembly. After logging in, it will say logged in or accepted. If it says rejected, you have already received a mail.
## Any More Questions?
Please send any questions not covered here to the Assembly Team: [rc3@c3assemblies.de](mailto:rc3@c3assemblies.de)
--
GitLab