STW: use development config in Makefile, documentation

.github/pull_request_template.md

@@ -1,6 +1,11 @@
 
 ### Opening a Pull Request to Update your Project
 
+I've started a documentation on how we should use the forking workflow here:
+
+[https://github.com/htw-imi-showtime/showtime-website/blob/documentation/doc/forking-workflow/index.md](https://github.com/htw-imi-showtime/showtime-website/blob/documentation/doc/forking-workflow/index.md)
+(will not be merged to main due to file sizes)
+
 Please follow these Steps & Guidelines for your Pull Request:
 
 #### Before you Request a Review Check and Tick these Boxes:
@@ -32,7 +37,7 @@ the script above - WITHOUT CHECKING THE QUALITY**
 4. If your disk usage exceeds 500K, provide a reason while you want to include so many images or why certain images need to be that big:
 
 
-#### If the checks fail...
+#### IMPORTANT: if you run into trouble / If the checks fail...
 
 - if you cannot figure out why a check fails or you think that it may be wrong, 
   don't hesitate to contact me! (e.g. by requesting a review and commenting in the pr)

Makefile

@@ -4,7 +4,7 @@
 hugo :  open
 #-  hugo --baseURL http://localhost:1313/pathprefix --navigateToChanged --port=1313 server
 # -  hugo --baseURL http://localhost:1313/pathprefix --navigateToChanged --buildDrafts -p 1313 server
--  hugo --baseURL http://localhost:1313/pathprefix --navigateToChanged --buildDrafts --environment pull_request -p 1313 server
+-  hugo --baseURL http://localhost:1313/pathprefix --navigateToChanged --buildDrafts --environment development -p 1313 server
 
 hugoP :  open
 -  hugo -p 1313 server

README.md

@@ -135,9 +135,19 @@ git push
 
 Once your branch was merged, you may preview your project's page on our staging server: https://htw-imi-showtime.github.io/
 
+### We are using the Forking Workflow.
+
+Note: we are essentially using the "Forking Workflow" as described in the Atlassian Documentation here:
+[https://www.atlassian.com/git/tutorials/comparing-workflows/forking-workflow](https://www.atlassian.com/git/tutorials/comparing-workflows/forking-workflow)
+
+I've started a documentation on how we should use the forking workflow here:
+
+[https://github.com/htw-imi-showtime/showtime-website/blob/documentation/doc/forking-workflow/index.md](https://github.com/htw-imi-showtime/showtime-website/blob/documentation/doc/forking-workflow/index.md)
+(will not be merged to main due to file sizes)
+
+
 ## Deploy your Fork on GH-Pages
 
-** funktioniert wieder! **
 
 You can easily deploy your fork on GH-Pages by following the instructions here:
 [http://about-hugo.github.io/hugo/quick/](http://about-hugo.github.io/hugo/quick/)

config/development/config.toml

@@ -0,0 +1,3 @@
+[params]
+    preview_message = "Local Dev"
+    #preview_url = "https://github.com/htw-imi-showtime/showtime-website/pull/101"

doc/update.md

@@ -38,12 +38,34 @@ We are using the Forking Workflow that is common to contribute to open source re
 
 1. update clone
 
+Recommended: keep your main branch in sync with upstream/main. Do not change it directly.
+
+a. Setup:
+```bash
+    git remote add upstream [email protected]:htw-imi-showtime/showtime-website.git
+    git fetch upstream main
+```
+b. Update (do often )
+
+```bash
+    git checkout main
+    git pull upstream main
+    git submodule update
+    git checkout <your-current-branch>
+    git merge main
+```
+
+if you want to merge upstream/main directly, without updating main:
+
 ```bash
     git remote add upstream [email protected]:htw-imi-showtime/showtime-website.git
     git fetch upstream main
-    git merge --no-ff upstream/main
+    git merge upstream/main
+    git submodule update
 ```
 
+
+
 Check message for possible merge conflicts; resolve merge conflicts. 
 As you should not change any files other than in your project repo, 
 these should be the only ones.
@@ -55,7 +77,12 @@ then `git push` your changes.
 ## update theme
 or: **OMG! there are changes in themes/showtime-theme-2021** and **this was not me!!**
 
-tl;dr: run `git submodule update``
+### tl;dr: run `git submodule update``
+
+```bash
+git submodule update
+```
+### More text
 
 After the successful merge, git status may still show changes in a submodule:
 (the same may be the case for the project-archive submodule if you checked it out)
@@ -83,3 +110,15 @@ than the one that was included in upstream/main - run this to check it:
 run `git submodule update` to resolve this.
 
 
+## Git submodules are not rocket science
+
+there's simply a .gitmodules file that list the submodules:
+```bash
+cat .gitmodules
+```
+
+
+[submodule "themes/showtime-theme-2021"]
+        path = themes/showtime-theme-2021
+        url = ../../htw-imi-showtime/showtime-theme-2021.git
+        branch = main