diff --git a/.gitattributes b/.gitattributes index 680fa2f..a849753 100644 --- a/.gitattributes +++ b/.gitattributes @@ -1 +1 @@ -.mp4 filter=lfs diff=lfs merge=lfs -text +.mp4 filter=lfs diff=lfs merge=lfs -text diff --git a/.gitignore b/.gitignore index 8dd6d56..d40a4d4 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,2 @@ -public/ -.hugo_build.lock +public/ +.hugo_build.lock diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index dd996fd..24bf1b7 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -1,22 +1,22 @@ -# All available Hugo versions are listed here: https://gitlab.com/pages/hugo/container_registry -image: registry.gitlab.com/pages/hugo:latest - -variables: - GIT_SUBMODULE_STRATEGY: recursive - -test: - allow_failure: true - script: - - hugo - except: - - master - -pages: - allow_failure: true - script: - - hugo - artifacts: - paths: - - public - only: - - master +# All available Hugo versions are listed here: https://gitlab.com/pages/hugo/container_registry +image: registry.gitlab.com/pages/hugo:latest + +variables: + GIT_SUBMODULE_STRATEGY: recursive + +test: + allow_failure: true + script: + - hugo + except: + - master + +pages: + allow_failure: true + script: + - hugo + artifacts: + paths: + - public + only: + - master diff --git a/.tool-versions b/.tool-versions new file mode 100644 index 0000000..c3dca58 --- /dev/null +++ b/.tool-versions @@ -0,0 +1 @@ +hugo 0.92.2 diff --git a/CREDIT b/CREDIT index c584a86..28c3914 100644 --- a/CREDIT +++ b/CREDIT @@ -1 +1 @@ -The credit of this project idea goes to one of our CR Master's students: Kai Azzaoui. Please follow him on SoundCloud here: https://soundcloud.com/user-326328403 +The credit of this project idea goes to one of our CR Master's students: Kai Azzaoui. Please follow him on SoundCloud here: https://soundcloud.com/user-326328403 diff --git a/LICENSE b/LICENSE index 2f3ee86..cb0ba54 100644 --- a/LICENSE +++ b/LICENSE @@ -1,21 +1,21 @@ -The MIT License (MIT) - -Copyright (c) 2014 Spencer Lyon - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +The MIT License (MIT) + +Copyright (c) 2014 Spencer Lyon + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. \ No newline at end of file diff --git a/README.md b/README.md index 7f07b88..67654b6 100644 --- a/README.md +++ b/README.md @@ -1,69 +1,69 @@ -Each time the main branch (i.e. the `master` branch) on this repo changes, the following website changes in response to that change: -https://rwth-crmasters-wise2122.gitlab.io/deep-music-visualizer-showdown/ - -The process responsible of this is called DevOps and is described in the file named `.gitlab-ci.yml` at the root of this repo. - -# An Example of a Website Development Process - -Using a Static-Site-Generation tool named _HUGO_ and a repository made up of markdown files, images/videos and HTML templates. - -Below is a diagram of what happens each time we change the repository: - -![HUGO Diagram](./docs/HUGO_big_picture.plain.svg) - -In any development team, you have to be on the same page with other developers in the team with regard to: -1. The _file-naming policy_: how to name the files we add to the repo in different directories -1. The _branch-naming policy_: how do we call our branches -1. The _merge-request documentation_: - - when to mark the merge request as a draft, - - how to name the merge request, - - what information to add to the merge-request body - -In the session on the 1st of December, 2021 of the DSSIPD course, **we did not have clear policies.** This resulted in a lot of inconsistency which would make managing the development difficult, and hence would be unacceptable in a professional environment. - -Hence, when joining a new development team, even if you are a consultant, a content creator, or a manager, it is important to ask how things are expected to be done to maximize the impact of your contributions and to minimize friction with coworkers and line managers. - -## Contribution Guidelines to this Repo - -In order to mitigate the problems above and to help you grow professionally, we came up with the following guidelines after the session on the 1st of December: - -1. **Filenames:** all filenmes should be in small-caps, dashes in-between words, and no spaces/special characters. More specifically: - 1. Filenames in `./static/videos/` (for the competition entry videos) use either your first name or your last name, depending on which one is more unique (if both are equally unique, then it is up to you to decide). If more than one video needs to be pushed, use a dash and a number before the extension (e.g. `orwa-1.mp4`, `orwa-2.mp4`) - 1. Filenames in `./content/post` (for the competition entry articles) follow the format "`YYYY`-`MM`-`DD`-`first`-`last`.md" (please see the examples in that directory) -1. **Branch names:** - 1. For branches adding a new competition entry: use _"competition-`first`-`last`"_ to indicate that it is a branch designating a competition entry and that it belongs to you. - 1. For branches fixing an issue: use _"bugfix-issue-`number`"_ where `number` is the issue number. - 1. For branches fixing a problem that had not been documented in an issue: use _"bugfix-`first`-`last`"_ - 1. For other types of improvements after your requirements are met: use _"feature-(`first`|`last`)-`...`"_ where the part _(`A`|`B`)_ means either `A` or `B` and the three dots `...` stand for anything you want assuming it is: - 1. All in small caps - 1. Uses dashes in-between the words - 1. No special characters -1. **Merge request:** please mark the merge request as a draft until you are sure that it runs correctly (using the *preview_website* batch file ran locally) and that all the changes you have made locally are already pushed to your branch on the remote. The title for the merge request should be: - 1. "Competition entry for `first` `last`" in case of requesting a merge of a competition entry - 1. "Bugfix for issue #`number`" in case of requetsing a merge of a requested change (using the _issues_ feature in GitLab) - 1. "Improved `first` `last`'s content" in cae of requesting a merge of an improved `.md` page - -In the meantime, we do not require any information or documents to be attached to the body of the merge request. - -## Adding a competition entry - -After creating your own branch (following the guidelines above). Follow these steps: - -1. Look for your video file in the `./static/video` folder on this repo, this has one of two possible outcomes: - 1. You found the video file(s), they have been pushed by the instructor from Moodle. Keep note of the filename stem (without the extension), and let's call that `video` and go to step 2 below. - 1. The file is not there, because you did not submit on time. In this case, you will have to commit your video file to `./content/video` (please follow the naming guidelines above). The stem of this filename (without the extension) is assume to be `video` in step 2 below. -2. After you identified the video, this is the time to add **a new `.md` file** in the `./content/post` directory of the repo (please follow the naming guidelines above). In this file, please use the contents of `2021-12-01-orwa-diraneyya.md` as a template while changing this line: - ``` - {{