Development: Migrate documentation to docs.artemis.cit.tum.de

.github/PULL_REQUEST_TEMPLATE.md

@@ -7,19 +7,19 @@
 <!-- If it's only a small change, testing it locally is acceptable and you may remove the first checkmark. If you are unsure, please test on the test servers. -->
 - [ ] I tested **all** changes and their related features with **all** corresponding user types on a test server.
 - [ ] This is a small issue that I tested locally and was confirmed by another developer on a test server.
-- [ ] Language: I followed the [guidelines for inclusive, diversity-sensitive, and appreciative language](https://ls1intum.github.io/Artemis/dev/guidelines/language-guidelines/).
-- [ ] I chose a title conforming to the [naming conventions for pull requests](https://ls1intum.github.io/Artemis/dev/development-process/#naming-conventions-for-github-pull-requests).
+- [ ] Language: I followed the [guidelines for inclusive, diversity-sensitive, and appreciative language](https://docs.artemis.cit.tum.de/dev/guidelines/language-guidelines/).
+- [ ] I chose a title conforming to the [naming conventions for pull requests](https://docs.artemis.cit.tum.de/dev/development-process/#naming-conventions-for-github-pull-requests).
 #### Server
 - [ ] **Important**: I implemented the changes with a very good performance and prevented too many (unnecessary) database calls.
-- [ ] I followed the [coding and design guidelines](https://ls1intum.github.io/Artemis/dev/guidelines/server/).
+- [ ] I followed the [coding and design guidelines](https://docs.artemis.cit.tum.de/dev/guidelines/server/).
 - [ ] I added multiple integration tests (Spring) related to the features (with a high test coverage).
-- [ ] I added pre-authorization annotations according to the [guidelines](https://ls1intum.github.io/Artemis/dev/guidelines/server/#rest-endpoint-best-practices-for-authorization) and checked the course groups for all new REST Calls (security).
+- [ ] I added pre-authorization annotations according to the [guidelines](https://docs.artemis.cit.tum.de/dev/guidelines/server/#rest-endpoint-best-practices-for-authorization) and checked the course groups for all new REST Calls (security).
 - [ ] I documented the Java code using JavaDoc style.
 #### Client
 - [ ] **Important**: I implemented the changes with a very good performance, prevented too many (unnecessary) REST calls and made sure the UI is responsive, even with large data.
-- [ ] I followed the [coding and design guidelines](https://ls1intum.github.io/Artemis/dev/guidelines/client/).
-- [ ] Following the [theming guidelines](https://ls1intum.github.io/Artemis/dev/guidelines/client-design/), I specified colors only in the theming variable files and checked that the changes look consistent in both the light and the dark theme.
-- [ ] I added multiple integration tests (Jest) related to the features (with a high test coverage), while following the [test guidelines](https://ls1intum.github.io/Artemis/dev/guidelines/client-tests/).
+- [ ] I followed the [coding and design guidelines](https://docs.artemis.cit.tum.de/dev/guidelines/client/).
+- [ ] Following the [theming guidelines](https://docs.artemis.cit.tum.de/dev/guidelines/client-design/), I specified colors only in the theming variable files and checked that the changes look consistent in both the light and the dark theme.
+- [ ] I added multiple integration tests (Jest) related to the features (with a high test coverage), while following the [test guidelines](https://docs.artemis.cit.tum.de/dev/guidelines/client-tests/).
 - [ ] I added `authorities` to all new routes and checked the course groups for displaying navigation elements (links, buttons).
 - [ ] I documented the TypeScript code using JSDoc style.
 - [ ] I added multiple screenshots/screencasts of my UI changes.
@@ -57,7 +57,7 @@ Prerequisites:
 
 1. Log in to Artemis
 2. Participate in the exam as a student
-3. Make sure that the UI of the programming exercise in the exam mode stays unchanged. You can use the [exam mode documentation](https://ls1intum.github.io/Artemis/user/exam_mode/) as reference.
+3. Make sure that the UI of the programming exercise in the exam mode stays unchanged. You can use the [exam mode documentation](https://docs.artemis.cit.tum.de/user/exam_mode/) as reference.
 4. ...
 
 ### Review Progress

.github/workflows/docs.yml

@@ -35,21 +35,45 @@ jobs:
         build-command: make html dirhtml
     - uses: actions/upload-artifact@v3
       with:
-        name: Documentation
+        name: documentation
         path: docs/_build/html/
-    - uses: actions/upload-pages-artifact@v2
-      with:
-        path: docs/_build/dirhtml/
 
   # Deployment job
   deploy:
     if: github.ref == 'refs/heads/develop'
     environment:
-      name: github-pages
-      url: "https://ls1intum.github.io/Artemis"
+      name: documentation
+      url: "https://docs.artemis.cit.tum.de"
     runs-on: ubuntu-latest
     needs: docs
     steps:
-      - name: Deploy to GitHub Pages
-        id: deployment
-        uses: actions/deploy-pages@v2
+      - name: Download artifact
+        uses: actions/download-artifact@v3
+        with:
+          name: documentation
+          path: public
+      - name: Copy site to server
+        uses: appleboy/scp-action@master
+        with:
+          host: docs.artemis.cit.tum.de
+          username: ${{ secrets.DOCS_SSH_USER }}
+          key: ${{ secrets.DOCS_SSH_PRIVATE }}
+          proxy_host: ${{ secrets.PROXY_HOST }}
+          proxy_username: ${{ secrets.PROXY_USERNAME }}
+          proxy_key: ${{ secrets.PROXY_KEY }}
+          proxy_port: ${{ secrets.PROXY_PORT }}
+          source: "public"
+          target: ${{ secrets.DOCS_HOME }}
+      - name: Move site to www
+        uses: appleboy/ssh-action@master
+        with:
+          host: docs.artemis.cit.tum.de
+          username: ${{ secrets.DOCS_SSH_USER }}
+          key: ${{ secrets.DOCS_SSH_PRIVATE }}
+          proxy_host: ${{ secrets.PROXY_HOST }}
+          proxy_username: ${{ secrets.PROXY_USERNAME }}
+          proxy_key: ${{ secrets.PROXY_KEY }}
+          proxy_port: ${{ secrets.PROXY_PORT }}
+          script: |
+              rm -rf ${{ secrets.DOCS_WWW }}/*
+              mv -f public/* ${{ secrets.DOCS_WWW }}/