UPdated docs
[stands-website.git] / README.md
index f9f2fce147b9a639c818ca61324c908e1e4ba912..05d4306ad0fc7e62aac2c21e9ae18e9427805644 100644 (file)
--- a/README.md
+++ b/README.md
@@ -46,6 +46,8 @@ We will clone the repositories you provided in two locations (corresponding to t
 
 ## Important files
 
+/<stand_name>.md is used for the rendering in the lists on /themes/ and /stands/; <stand_name>/\_index.md (if it exists) or <stand_name>.md is used for the page itself. Do not use _show\_on\_overview_ in your \_index.md file.
+
 ### _content/stands/<your stand>.md_
 
  * `content/stands/<your stand>.md` - generated by our custom highly advanced (;-)) script based on what you provided in your submission.
@@ -72,6 +74,7 @@ new_this_year: |
     _What has happened in 2020 to your project? You can use HTML (p, ul, etc.)_
 
 layout: stand
+chatroom: _Room name in pentabarf_
 ---
 ```
 
@@ -83,13 +86,41 @@ You must provide a _title_ parameter in the front matter of your other pages; ot
 
 ## Chatroom functionality
 
+Each stand will have a dedicated chatroom, created based on the information in *pentabarf*. Your chat room name is the same name as the _room_ you are
+scheduled in in pentabarf.
+
+We have put the name of the chatroom as *chatroom* on all stands pages. _However, if you provided your own \_index.md file, you *must add this parameter*, otherwise your chatroom link will not be functional._ You cannot change this yourself.
+
+Each chatroom will have the two contacts listed in your submission (and who created an account in Pentabarf) as _moderator_. Additionally, all FOSDEM staff
+will be given the same role. Moderators can invite other moderators, but note that you require a Matrix account for this.
+
 ## Video
-No youtube
 
-video.fosdem.org
+Because of our strict security settings, you cannot embed video's from Youtube (or any other video hosting site) - only from video.fosdem.org.
+
+You can upload video's via [penta.fosdem.org](https://penta.fosdem.org), where everybody should have an account (if not, contact _stands\_at\_fosdem.org_). The exact process is not automated yet, so you will have to send an e-mail to _stands\_at\_fosdem.org_ and we will provide you with the upload link.
+
+We've created four video events you can upload to (1 video per event). If you need more, let us know.
+
+The links are of the form _https://penta.fosdem.org/submission/FOSDEM21/event/\_event\_id\__.
+
+On the _Schedule_ tab in Pentabarf, you'll find a field called _Pre-recorded Video Upload URL_. Go to that link (you'll have to copy & paste) to upload the video.
+
+You'll have to wait a few minutes while the script transcodes the video. You can check the progress at [upload.video.fosdem.org/overview](https://upload.video.fosdem.org/overview) (select _Stand recordings_ and search for your project - you'll find 4 video's - check the one you uploaded).
+
+As soon as it says _preview_ on the overview, go back to Pentabarf, go to the schedule tab and check the field called _Video Review URL_. Go to that link to check your video, and if it is OK, confirm it (if it is not, you can upload a new version).
+
+Wait a few more minutes (30 or so) while it is pushed to our CDN.
+
+Go back to Pentabarf and the schedule tab, check the field _Final Video URL_. This is the URL of your video you can embed on your stand.
+
+Upload the video, it will be converted by our system. Afterwards, you review and approve the video, which will then be live.
+
+You can embed the video; the links will be of the form _https://video.fosdem.org/2021/stands/\_chatroom\_name\_\_video1.mp4_. Embedding is done using standard HTML. You can only embed video's in HTML content, not in Markdown. Note that all fields (description, new_this_year and showcase) will accept HTML and that any pages you add can be HTML as well.
 
-upload via penta
+## Welcome events on the schedule
 
+You can also edit the "welcome event" on the FOSDEM schedule (fosdem.org) in Pentabarf; search for the _Welcome to the stand <your project>_ event and edit the short and full abstract on the _Abstract_ tab.
 
 ## Technical details