The official IMI showtime website
Staging: https://htw-imi-showtime.github.io/
Website: https://showtime.f4.htw-berlin.de/
If you want to add your project to the website, please follow these steps and create a pull request when you're done:
- Fork the project to your GitHub account.
- Clone the project:
git clone --depth 1 --recurse-submodules https://github.com/<your-account>/showtime-website.git
cd showtime-website
or using SSH:
git clone --depth 1 --recurse-submodules git@github.com:<your-account>/showtime-website.git
cd showtime-website
-
Install Hugo (extended) from https://gohugo.io
You can check your installation by executinghugo server
and visiting http://localhost:1313/ in your browser. If you get an error:- Did you forget to clone the submodules? If so, you can get the theme submodule by running
git submodule update --init --recursive
- Did you install the Hugo extended version? This is needed for Hugo to correctly compile the theme's SCSS files
-
Create a new project directory for your project by duplicating either the bachelor's or the master's sample project directory:
cp -R content/ws21/bachelor/b0-template-project/ content/ws21/bachelor/b#-your-project/
cp -R content/ws21/master/m0-template-project/ content/ws21/master/m#-your-project/
Please make sure to include your project number! (e.g. B2, M1, ...)
- Fill out your project's homepage
content/ws21/<bachelor/master>/##-your-project/_index.md
and any subpages in your project's directory you'd like to keep. Delete the subpages you don't need.
Please don't use Markdown headings (hashtags) directly, since those headings won't be displayed correctly. Have a look at the section documentation below or the template projects for including headings.
If you need help with the markdown syntax, have a look at this Markdown Cheatsheet.
You may also put images in your project's directory (less than 100 MB per file, please upload videos to the HTW Mediathek and embed them). For an example on how to include videos, images, quotes and GitHub gists, please have a look at the documentation below or the examples included in the template projects. - Preview your changes locally to make sure everything looks fine by executing
hugo server
and visiting http://localhost:1313/ in your browser. - Add your changes to the git index, commit them to the repository and push them to GitHub:
git add content/ws21/<bachelor|master>/<project_number-your-project>
git commit -m "Your commit message"
git push
- Create a new pull request on GitHub that merges your version of the repo's
master
branch onto the htw-imi-showtimemaster
branch. (GitHub Help: Creating a pull request from a fork)
Once your branch was merged, you may preview your project's page on our staging server: https://htw-imi-showtime.github.io/
One week before the Showtime takes place, the website will be published on our production server: https://showtime.f4.htw-berlin.de/
To get the updates on the central repository into your fork, do the following: (see Github on Syncing a Fork )
git remote add upstream git@github.com:htw-imi-showtime/showtime-website.git
git fetch upstream
git merge upstream/master
To update the theme submodule, run
git submodule update
In addition to the required content you can add any content you want - at least this term (winter semester 2021/22) this site replaces the Showtime Fair with the booths and posters. Please consider
- the Urheberrecht for all material you provide: Include the information (source, creator etc.) in the caption
- please reduce the file sizes for all images and videos that are included in the site
Please do not add new subpages or change the names of the included subpages. We want all the projects to have a similar structure, so the website is more consistent for visitors.
A section "pairs" a text block (one or multiple paragraphs) with a heading.
Note that the caption parameter is optional and may be left out for disabling the caption.
Example: Including image.png
with "Alt text" as alt text and "Is displayed below the image" as caption.
Example: Including image.png
with "Alt text" as alt text and no caption:
If you want to display multiple images next to each other (e.g. app screenshots) instead of displaying them over the full width of the page, you may use the gallery shortcode to do so. The gallery displays up to three images next to each other. When a row reaches three images and another image is added to the gallery, it will continue in the next row.
The team gallery displays images of your team using round images. For an example please also have a look at the bachelor's template project.
Please upload your videos to the HTW Mediathek and embed them using the Mediathek Player. Please DO NOT embed YouTube-Videos into your project pages (The YouTube video player doesn't conform to/is not covered in our privacy policy).
Note that the title parameter is optional and may be left out for only displaying the player without a heading.
Example: Embedding https://mediathek.htw-berlin.de/video/Clean-Code-Presentation-on-Comment/117e5ae717b582bdeac13d95e8fa2264
Example: Embedding https://gist.github.com/Kaes3kuch3n/643befb000375fea7c5f675fb180cfbd
This repository contains a utility script to transition the website to a new semester.
It changes the semester set in the config file (current_semester
in config/_default/config.toml
) and
scaffolds the folder structure for the projects of the new semester.
./new_semester.sh <semester>
Example: Transitioning to summer semester 2021/22
./new_semester.sh ss21
Every push on main is deployed to the Github Page in the repo https://github.com/htw-imi-showtime/htw-imi-showtime.github.io
see the workflow definition in .github/workflows/deploy-staging.yml
the secret ACTIONS_DEPLOY_KEY in https://github.com/htw-imi-showtime/showtime-website/settings/secrets/actions
is defined in https://github.com/htw-imi-showtime/htw-imi-showtime.github.io/settings/keys
For production, each github release is build and scp'ed to showtime.f4.htw-berlin.de
see the workflow definition in .github/workflows/deploy-production.yml
for the scp, the rsa key credentials must be set correctly in the Repo's Secrets - generate new ones with root access on the server if lost.
- Tag the according commit and push the tag: git tag 2021.1.2 git push
with 2021.1 for the first semester in 2021 (summer) and .2 for the second version.