The stands.fosdem.org exhibition website is a static website generated with [Hugo](https://gohugo.io/). There is a general part,
created by FOSDEM, containing an overview of each stand, a thematic ordering and some general information, and a stand-specific part.
-We create the general part and will seed the stand-specific part with what you provided during your submission in the _\_index.md_. You can
-update the contents of the file, but please make sure you do not remove any of the variables in the _[front matter](https://gohugo.io/content-management/front-matter/)_, otherwise the generator
+We create the general part and will seed the stand-specific part with what you provided during your submission in the _project name.md_. You can
+update the contents of the file (via a pull request), but please make sure you do not remove any of the variables in the _[front matter](https://gohugo.io/content-management/front-matter/)_, otherwise the generator
will crash.
We've asked for two repositories from you, one with the content (Hugo content files) and one with static files. These repositories do not have
We automatically generate a link to your video repository and the chatroom.
Your stand will live under _stands.fosdem.org/stands/<your project>_.
+
+## Workflow
+
+We need two repositories from you, one containing your content (pages) and one containing your static files. All files should go directly in the root of that repository (you should not create a hugo site, it is not necessary).
+
+To add your content to the [main website](https://stands.fosdem.org), two options are possible:
+
+ * Send us an e-mail with both repositories. We will add them as git submodules; content under _content/stands/your\_stand\_name_ (the name of your stand, or at least the directory, is the same name as the .md file already in _content/stands_ (minus the extension)) and static files under _static/stands/your\_stand\_name_.
+ * Fork and clone this repository, add them yourself (respect the paths please) and create a pull request.
+
+A cronjob will pull the code and rebuild the website every hour.
+
+If you wish to test your changes locally, you'll have to clone this repository, add the submodules as described above (synchronise them by executing _git submodule init_ and _git submodule update_) and test them with _hugo serve_. Any changes must be made in your local repositories.
+
+If you wish to change anything in the _content/stands/<your stand>.md_ file (which you can and should), please open a pull request.
## Directory structure
## Important files
-### _index.md
+/<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>/_index.md` - generated by our custom highly advanced (;-)) script based on what you provided in your submission.
+ * `content/stands/<your stand>.md` - generated by our custom highly advanced (;-)) script based on what you provided in your submission.
-The contents of the _\_index.md_ file can be changed as you wish, but please make sure you do not remove any of the variables (changing the content
+The contents of the _.md_ file can be changed as you wish, but please make sure you do not remove any of the variables (changing the content
is fine) of the _front matter_, otherwise the generator will not work. Please do not change the theme or the layout.
#### Front matter
_What has happened in 2020 to your project? You can use HTML (p, ul, etc.)_
layout: stand
+chatroom: _Room name in pentabarf_
---
```
All other files can by any content Hugo accepts (HTML, MD).
+You must provide a _title_ parameter in the front matter of your other pages; otherwise the links will not work.
+
+## 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
+
+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.
+
+## 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
We use Bootstrap (4.5) for styling, so you can as well. jQuery is included (for Bootstrap), so you can use it.
-Please not that you cannot load any assets (images, css or js) from any other domain than stands.fosdem.org.
+Please note that you cannot load any assets (images, css or js) from any other domain than stands.fosdem.org.
## Local development environment
-To test your changes locally, this is what you can do.
+To test your changes locally, this is what you can do (you'll need the Hugo binary).
+
+1. Clone the repository.
+2. Put your content directly in _content/stands/your stand_ and _static/stands/your stand_. We use submodules to link everything together, so your content must go there directly.
+3. Run _hugo serve_.
+4. Profit!
+If you notice anything amiss, let us know via _stands\_at\_fosdem\_dot\_org_. Or open a pull request ;-)
## Feedback
projects / stands-website.git / blobdiff