From eafaf2049f80b4609e3a59d6fa163d45a5bdd347 Mon Sep 17 00:00:00 2001 From: Ignacio G Date: Fri, 29 Sep 2023 15:38:28 +0200 Subject: [PATCH 1/5] Modify docs.yml workflow to deploy on docs.artemis.ase.cit.tum.de --- .github/workflows/docs.yml | 40 ++++++++++++++++++++++++++++++-------- 1 file changed, 32 insertions(+), 8 deletions(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index dc6e103ffd29..b6a0633090e0 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -37,19 +37,43 @@ jobs: with: 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: www + 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: | + sudo rm -rf ${{ secrets.DOCS_WWW }}/* + sudo mv -f public/* ${{ secrets.DOCS_WWW }}}/ From 3160e903e56e2af43c4baeefc068c5be8c38b931 Mon Sep 17 00:00:00 2001 From: Ignacio G Date: Fri, 29 Sep 2023 15:45:16 +0200 Subject: [PATCH 2/5] Replace all occurrences of ls1intum.github.io/Artemis with docs.artemis.cit.tum.de --- .github/PULL_REQUEST_TEMPLATE.md | 16 ++--- README.md | 58 +++++++++---------- docker/artemis.yml | 2 +- docker/artemis/config/dev.env | 2 +- docs/dev/setup/kubernetes.rst | 2 +- .../enumeration/TextAssessmentEventType.java | 2 +- .../NotificationSettingsService.java | 4 +- .../templates/haskell/test/readme.md | 2 +- .../app/core/about-us/about-us.component.ts | 42 +++++++------- .../exam-checklist.component.html | 2 +- .../documentation-button.component.ts | 2 +- .../documentation-button.component.spec.ts | 2 +- 12 files changed, 68 insertions(+), 68 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 3a64a36f2dfc..d983f55d6421 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -7,19 +7,19 @@ - [ ] 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 diff --git a/README.md b/README.md index 69f118e11e07..6f51e7d15e58 100644 --- a/README.md +++ b/README.md @@ -2,14 +2,14 @@ [![Build & Deploy](https://github.com/ls1intum/Artemis/actions/workflows/build.yml/badge.svg?event=push)](https://github.com/ls1intum/Artemis/actions/workflows/build.yml) [![Test](https://github.com/ls1intum/Artemis/actions/workflows/test.yml/badge.svg?event=push)](https://github.com/ls1intum/Artemis/actions/workflows/test.yml) -[![Documentation](https://github.com/ls1intum/Artemis/actions/workflows/docs.yml/badge.svg?event=push)](https://ls1intum.github.io/Artemis) +[![Documentation](https://github.com/ls1intum/Artemis/actions/workflows/docs.yml/badge.svg?event=push)](https://docs.artemis.cit.tum.de) [![Code Quality Status](https://app.codacy.com/project/badge/Grade/89860aea5fa74d998ec884f1a875ed0c)](https://www.codacy.com/gh/ls1intum/Artemis?utm_source=github.com&utm_medium=referral&utm_content=ls1intum/Artemis&utm_campaign=Badge_Grade) [![Coverage Status](https://app.codacy.com/project/badge/Coverage/89860aea5fa74d998ec884f1a875ed0c)](https://www.codacy.com/gh/ls1intum/Artemis?utm_source=github.com&utm_medium=referral&utm_content=ls1intum/Artemis&utm_campaign=Badge_Coverage) [![Latest version)](https://img.shields.io/github/v/tag/ls1intum/Artemis?label=%20Latest%20version&sort=semver)](https://github.com/ls1intum/Artemis/releases/latest) ## Main features -1. **[Programming exercises](https://ls1intum.github.io/Artemis/user/exercises/programming/)** with version control, automatic individual feedback (and assessment) based on test cases and static code analysis (executed using continuous integration). +1. **[Programming exercises](https://docs.artemis.cit.tum.de/user/exercises/programming/)** with version control, automatic individual feedback (and assessment) based on test cases and static code analysis (executed using continuous integration). * **Instant**: Students receive immediate and individual feedback on submissions. Instructors can customize feedback messages easily, hide feedback during the working time (e.g., with hidden tests) * **Interactive:** Instructors integrate interactive instructions based on tasks and UML diagrams directly into the dynamic problem statements. They can define hints for difficult exercise parts. * **Independent**: Instructors can customize programming exercises to support any programming language. To simplify the setup, Artemis includes sophisticated templates for the most common languages (e.g., Java, Python, C, Haskell, Kotlin, VHDL, Assembler, Swift, Ocaml, ...) @@ -18,34 +18,34 @@ * **Policies**: Instructors can define submission policies (e.g., penalties after 10 attempts) to prevent that students try out all possibilities without thinking. * **Grading**: Instructors have many options to configure grading, analyze the results based on tests and static code analysis categories and re-evaluate the results * **Secure**: Test cases and student code run in Docker environments on build agents. Test frameworks such as [Ares](https://github.com/ls1intum/Ares) simplify the creation of structural and dynamic tests and prevent that students can cheat. -2. **[Quiz exercises](https://ls1intum.github.io/Artemis/user/exercises/quiz/)** with multiple choice, drag and drop, and short answer questions +2. **[Quiz exercises](https://docs.artemis.cit.tum.de/user/exercises/quiz/)** with multiple choice, drag and drop, and short answer questions * **Modeling quizzes**: Instructors can easily create drag and drop quizzes based on UML models * **Different modes**: Quizzes support a live mode (rated) during lectures, a practice mode for students to repeat the quiz as often as they want, and an exam mode (see below) -3. **[Modeling exercises](https://ls1intum.github.io/Artemis/user/exercises/modeling/)** based on the easy-to-use online modeling editor [Apollon](https://apollon.ase.in.tum.de) with semi-automatic assessment using machine learning concepts +3. **[Modeling exercises](https://docs.artemis.cit.tum.de/user/exercises/modeling/)** based on the easy-to-use online modeling editor [Apollon](https://apollon.ase.in.tum.de) with semi-automatic assessment using machine learning concepts * **Multiple diagram types**: Artemis supports 7 UML diagram types (e.g. class diagrams) and 4 additional diagrams (e.g. flow charts) * **Easy to use**: Students can create models easily using drag and drop, they can explain the models using additional text. * **Integrated feedback**: Reviews can provide feedback and points directly next to the model elements. -4. **[Text exercises](https://ls1intum.github.io/Artemis/user/exercises/textual/)** with manual, semi-automatic assessment based on supervised machine learning and natural language processing (NLP) using [Athena](https://github.com/ls1intum/Athena) +4. **[Text exercises](https://docs.artemis.cit.tum.de/user/exercises/textual/)** with manual, semi-automatic assessment based on supervised machine learning and natural language processing (NLP) using [Athena](https://github.com/ls1intum/Athena) * **Integrated feedback**: Reviews can provide feedback and points directly next to the text segments. * **Language detection**: Artemis detects the language of the submission and shows the word and character count. -5. **[File upload exercises](https://ls1intum.github.io/Artemis/user/exercises/file-upload/)** with manual assessment -6. **[Exam mode](https://ls1intum.github.io/Artemis/user/exam_mode/)**: Instructors can create online exams with exercise variants, integrated plagiarism checks, test runs and student reviews. You can find more information on [Exam mode student features](https://artemis.cit.tum.de/features/students) and on [Exam mode instructor features](https://artemis.cit.tum.de/features/instructors). -7. **[Grading](https://ls1intum.github.io/Artemis/user/grading/)**: Instructors can configure grade keys for courses and exams to automatically calculate grades and display them to students. Grades can be easily exported as csv files to upload them into university systems (such as Campus online). Instructors can optionally define bonus configurations for final exams to improve student grades according to their grades from a midterm exam or course exercises. -8. **[Assessment](https://ls1intum.github.io/Artemis/user/exercises/assessment/)**: Artemis uses double-blind grading and structured grading criteria to improve consistency and fairness. It integrates an assessment training process (based on example submissions and example assessments defined by the instructor), has a grading leader board, and allows students to rate the assessments. Students can complain or ask for more feedback. -9. **[Communication](https://ls1intum.github.io/Artemis/user/communication/)**: Instructors can post announcements. Students can ask questions, post comments, and react to other posts. Tutors can filter unanswered questions. -10. **[Notifications](https://ls1intum.github.io/Artemis/user/notifications)**: Artemis supports customizable web and email notifications. Users can enable and disable different notification types. -11. **[Team Exercises](https://ls1intum.github.io/Artemis/user/exercises/team-exercises/)**: Instructors can configure team exercises with real time collaboration and dedicated tutors per team. -12. **[Lectures](https://ls1intum.github.io/Artemis/user/lectures/)**: Instructors can upload lecture slides, divide lectures into units, integrate video streams, lecture recordings, and exercises into lectures, and define competencies. -13. **[Integrated Markdown Editor](https://ls1intum.github.io/Artemis/user/markdown-support/)**: Markdown is used to format text content across the platform using an integrated markdown editor. -14. **[Plagiarism checks](https://ls1intum.github.io/Artemis/user/plagiarism-check/)**: Artemis integrates plagiarism checks for programming exercises (based on [JPlag](https://github.com/jplag/JPlag)), text exercises, and modeling exercises in courses and exams. It allows notifying students about identified plagiarism. Students can review and comment on the allegation. -15. **[Learning analytics](https://ls1intum.github.io/Artemis/user/learning-analytics/)**: Artemis integrated different statistics for students to compare themselves to the course average. It allows instructors to evaluate the average student performance based on exercises and competencies. -16. **[Adaptive Learning](https://ls1intum.github.io/Artemis/user/adaptive-learning/)**: Artemis allows instructors and students to define and track competencies. Students can monitor their progress towards these goals, while instructors can provide tailored feedback. This approach integrates lectures and exercises under overarching learning objectives. -17. **[Tutorial Groups](https://ls1intum.github.io/Artemis/user/tutorialgroups/)**: Artemis support the management of tutorial groups of a course. This includes planning the sessions, assigning responsible tutors, registering students and tracking the attendance. +5. **[File upload exercises](https://docs.artemis.cit.tum.de/user/exercises/file-upload/)** with manual assessment +6. **[Exam mode](https://docs.artemis.cit.tum.de/user/exam_mode/)**: Instructors can create online exams with exercise variants, integrated plagiarism checks, test runs and student reviews. You can find more information on [Exam mode student features](https://artemis.cit.tum.de/features/students) and on [Exam mode instructor features](https://artemis.cit.tum.de/features/instructors). +7. **[Grading](https://docs.artemis.cit.tum.de/user/grading/)**: Instructors can configure grade keys for courses and exams to automatically calculate grades and display them to students. Grades can be easily exported as csv files to upload them into university systems (such as Campus online). Instructors can optionally define bonus configurations for final exams to improve student grades according to their grades from a midterm exam or course exercises. +8. **[Assessment](https://docs.artemis.cit.tum.de/user/exercises/assessment/)**: Artemis uses double-blind grading and structured grading criteria to improve consistency and fairness. It integrates an assessment training process (based on example submissions and example assessments defined by the instructor), has a grading leader board, and allows students to rate the assessments. Students can complain or ask for more feedback. +9. **[Communication](https://docs.artemis.cit.tum.de/user/communication/)**: Instructors can post announcements. Students can ask questions, post comments, and react to other posts. Tutors can filter unanswered questions. +10. **[Notifications](https://docs.artemis.cit.tum.de/user/notifications)**: Artemis supports customizable web and email notifications. Users can enable and disable different notification types. +11. **[Team Exercises](https://docs.artemis.cit.tum.de/user/exercises/team-exercises/)**: Instructors can configure team exercises with real time collaboration and dedicated tutors per team. +12. **[Lectures](https://docs.artemis.cit.tum.de/user/lectures/)**: Instructors can upload lecture slides, divide lectures into units, integrate video streams, lecture recordings, and exercises into lectures, and define competencies. +13. **[Integrated Markdown Editor](https://docs.artemis.cit.tum.de/user/markdown-support/)**: Markdown is used to format text content across the platform using an integrated markdown editor. +14. **[Plagiarism checks](https://docs.artemis.cit.tum.de/user/plagiarism-check/)**: Artemis integrates plagiarism checks for programming exercises (based on [JPlag](https://github.com/jplag/JPlag)), text exercises, and modeling exercises in courses and exams. It allows notifying students about identified plagiarism. Students can review and comment on the allegation. +15. **[Learning analytics](https://docs.artemis.cit.tum.de/user/learning-analytics/)**: Artemis integrated different statistics for students to compare themselves to the course average. It allows instructors to evaluate the average student performance based on exercises and competencies. +16. **[Adaptive Learning](https://docs.artemis.cit.tum.de/user/adaptive-learning/)**: Artemis allows instructors and students to define and track competencies. Students can monitor their progress towards these goals, while instructors can provide tailored feedback. This approach integrates lectures and exercises under overarching learning objectives. +17. **[Tutorial Groups](https://docs.artemis.cit.tum.de/user/tutorialgroups/)**: Artemis support the management of tutorial groups of a course. This includes planning the sessions, assigning responsible tutors, registering students and tracking the attendance. 18. **[Iris](https://artemis.cit.tum.de/about-iris)**: Artemis integrates Iris, a chatbot that supports students and instructors with common questions and tasks. -19. **[Scalable](https://ls1intum.github.io/Artemis/user/scaling/)**: Artemis scales to multiple courses with thousands of students. In fact, the largest course had 2,400 students. Administrators can easily scale Artemis with additional build agents in the continuous integration environment. -20. **[High user satisfaction](https://ls1intum.github.io/Artemis/user/user-experience/)**: Artemis is easy to use, provides guided tutorials. Developers focus on usability, user experience, and performance. +19. **[Scalable](https://docs.artemis.cit.tum.de/user/scaling/)**: Artemis scales to multiple courses with thousands of students. In fact, the largest course had 2,400 students. Administrators can easily scale Artemis with additional build agents in the continuous integration environment. +20. **[High user satisfaction](https://docs.artemis.cit.tum.de/user/user-experience/)**: Artemis is easy to use, provides guided tutorials. Developers focus on usability, user experience, and performance. 21. **Customizable**: It supports multiple instructors, editors, and tutors per course and allows instructors to customize many course settings -22. **[Open-source](https://ls1intum.github.io/Artemis/dev/open-source/)**: Free to use with a large community and many active maintainers. +22. **[Open-source](https://docs.artemis.cit.tum.de/dev/open-source/)**: Free to use with a large community and many active maintainers. ## Roadmap @@ -67,24 +67,24 @@ The Artemis development team prioritizes the following issues in the future. We ### Development setup, coding, and design guidelines -* [How to set up your local development environment](https://ls1intum.github.io/Artemis/dev/setup/) -* [Server coding and design guidelines](https://ls1intum.github.io/Artemis/dev/guidelines/server/) -* [Client coding and design guidelines](https://ls1intum.github.io/Artemis/dev/guidelines/client/) -* [Code Review Guidelines](https://ls1intum.github.io/Artemis/dev/development-process/#review) +* [How to set up your local development environment](https://docs.artemis.cit.tum.de/dev/setup/) +* [Server coding and design guidelines](https://docs.artemis.cit.tum.de/dev/guidelines/server/) +* [Client coding and design guidelines](https://docs.artemis.cit.tum.de/dev/guidelines/client/) +* [Code Review Guidelines](https://docs.artemis.cit.tum.de/dev/development-process/#review) ### Documentation -The Artemis documentation is available [here](https://ls1intum.github.io/Artemis/). +The Artemis documentation is available [here](https://docs.artemis.cit.tum.de/). You can find a guide on [how to write documentation](docs/README.md). ### Server setup -You can set up Artemis in conjunction with either [`GitLab and Jenkins`](https://ls1intum.github.io/Artemis/dev/setup/#jenkins-and-gitlab-setup), [`GitLab and GitLab CI (experimental)`](https://ls1intum.github.io/Artemis/dev/setup/#gitlab-ci-and-gitlab-setup), [`Jira, Bitbucket and Bamboo`](https://ls1intum.github.io/Artemis/dev/setup/#bamboo-bitbucket-and-jira-setup), or with [`local CI and local VC`](https://ls1intum.github.io/Artemis/dev/setup/#local-ci-and-local-vc-setup). +You can set up Artemis in conjunction with either [`GitLab and Jenkins`](https://docs.artemis.cit.tum.de/dev/setup/#jenkins-and-gitlab-setup), [`GitLab and GitLab CI (experimental)`](https://docs.artemis.cit.tum.de/dev/setup/#gitlab-ci-and-gitlab-setup), [`Jira, Bitbucket and Bamboo`](https://docs.artemis.cit.tum.de/dev/setup/#bamboo-bitbucket-and-jira-setup), or with [`local CI and local VC`](https://docs.artemis.cit.tum.de/dev/setup/#local-ci-and-local-vc-setup). Artemis uses these external tools for user management and the configuration of programming exercises. ### Administration setup -If needed, you can configure self service [user registration](https://ls1intum.github.io/Artemis/admin/registration). +If needed, you can configure self service [user registration](https://docs.artemis.cit.tum.de/admin/registration). ### Contributing @@ -134,7 +134,7 @@ This will create a Artemis-.war file in the folder `build/libs`. The bu java -jar build/libs/*.war --spring.profiles.active=dev,artemis,bamboo,bitbucket,jira ``` -(You might need to copy a yml file into the folder build/libs before, also see [development setup](https://ls1intum.github.io/Artemis/dev/setup/)) +(You might need to copy a yml file into the folder build/libs before, also see [development setup](https://docs.artemis.cit.tum.de/dev/setup/)) Then navigate to [http://localhost:8080](http://localhost:8080) in your browser. diff --git a/docker/artemis.yml b/docker/artemis.yml index 19cfb0e0bf12..624874392aba 100644 --- a/docker/artemis.yml +++ b/docker/artemis.yml @@ -6,7 +6,7 @@ services: artemis-app: container_name: artemis-app # look in the docs for more information about how to build your Artemis code with Docker - # https://ls1intum.github.io/Artemis/dev/setup/# + # https://docs.artemis.cit.tum.de/dev/setup/# image: ghcr.io/ls1intum/artemis build: context: .. diff --git a/docker/artemis/config/dev.env b/docker/artemis/config/dev.env index 4dc4617261bd..cc9259a8a670 100644 --- a/docker/artemis/config/dev.env +++ b/docker/artemis/config/dev.env @@ -7,5 +7,5 @@ SPRING_PROFILES_ACTIVE: artemis,scheduling,athena,dev,docker # The following enables the Java Remote Debugging port. More infos in the documentation: -# https://ls1intum.github.io/Artemis/dev/setup.html#debugging-with-docker +# https://docs.artemis.cit.tum.de/dev/setup.html#debugging-with-docker _JAVA_OPTIONS: -agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=*:5005 diff --git a/docs/dev/setup/kubernetes.rst b/docs/dev/setup/kubernetes.rst index 373b5f899847..08acd693e1ba 100644 --- a/docs/dev/setup/kubernetes.rst +++ b/docs/dev/setup/kubernetes.rst @@ -288,7 +288,7 @@ If you want to run with local user management and no programming exercises setup 1. Go to the ``src/main/resources/config/application-artemis.yml`` file, and set use-external in the user-management section to false. If you have created an additional ``application-local.yml`` file as it is described in the -`Setup documentation `__, make sure to edit this one. +`Setup documentation `__, make sure to edit this one. Another possibility is to add the variable directly in ``src/main/kubernetes/artemis/configmap/artemis-configmap.yml``. diff --git a/src/main/java/de/tum/in/www1/artemis/domain/enumeration/TextAssessmentEventType.java b/src/main/java/de/tum/in/www1/artemis/domain/enumeration/TextAssessmentEventType.java index 0ea89bf797e1..8434d51e1ebb 100644 --- a/src/main/java/de/tum/in/www1/artemis/domain/enumeration/TextAssessmentEventType.java +++ b/src/main/java/de/tum/in/www1/artemis/domain/enumeration/TextAssessmentEventType.java @@ -5,7 +5,7 @@ * Enumerates the names of events that are tracked when users interact with the assessment * system in text exercises * More detailed info in the documentation: - * https://ls1intum.github.io/Artemis/dev/setup/#configure-text-assessment-analytics-service + * https://docs.artemis.cit.tum.de/dev/setup/#configure-text-assessment-analytics-service */ public enum TextAssessmentEventType { ADD_FEEDBACK_AUTOMATICALLY_SELECTED_BLOCK, ADD_FEEDBACK_MANUALLY_SELECTED_BLOCK, DELETE_FEEDBACK, EDIT_AUTOMATIC_FEEDBACK, SUBMIT_ASSESSMENT, ASSESS_NEXT_SUBMISSION diff --git a/src/main/java/de/tum/in/www1/artemis/service/notifications/NotificationSettingsService.java b/src/main/java/de/tum/in/www1/artemis/service/notifications/NotificationSettingsService.java index 81981bd2b20d..0bf34ed302c4 100644 --- a/src/main/java/de/tum/in/www1/artemis/service/notifications/NotificationSettingsService.java +++ b/src/main/java/de/tum/in/www1/artemis/service/notifications/NotificationSettingsService.java @@ -150,7 +150,7 @@ public class NotificationSettingsService { Map.entry(NOTIFICATION__USER_NOTIFICATION__NEW_REPLY_IN_CONVERSATION_MESSAGE, new NotificationType[] { CONVERSATION_NEW_REPLY_MESSAGE })); // This set has to equal the UI configuration in the client notification settings structure file! - // More information on supported notification types can be found here: https://ls1intum.github.io/Artemis/user/notifications/ + // More information on supported notification types can be found here: https://docs.artemis.cit.tum.de/user/notifications/ // Please adapt the above docs if you change the supported notification types private static final Set NOTIFICATION_TYPES_WITH_INSTANT_NOTIFICATION_SUPPORT = Set.of(EXERCISE_RELEASED, EXERCISE_PRACTICE, ATTACHMENT_CHANGE, NEW_ANNOUNCEMENT_POST, FILE_SUBMISSION_SUCCESSFUL, EXERCISE_SUBMISSION_ASSESSED, DUPLICATE_TEST_CASE, NEW_PLAGIARISM_CASE_STUDENT, PLAGIARISM_CASE_VERDICT_STUDENT, @@ -159,7 +159,7 @@ public class NotificationSettingsService { NEW_LECTURE_POST, NEW_REPLY_FOR_LECTURE_POST, NEW_COURSE_POST, NEW_REPLY_FOR_COURSE_POST, NEW_REPLY_FOR_EXERCISE_POST, QUIZ_EXERCISE_STARTED, DATA_EXPORT_CREATED, DATA_EXPORT_FAILED, CONVERSATION_NEW_MESSAGE, CONVERSATION_NEW_REPLY_MESSAGE); - // More information on supported notification types can be found here: https://ls1intum.github.io/Artemis/user/notifications/ + // More information on supported notification types can be found here: https://docs.artemis.cit.tum.de/user/notifications/ // Please adapt the above docs if you change the supported notification types private static final Set INSTANT_NOTIFICATION_TYPES_WITHOUT_EMAIL_SUPPORT = Set.of(QUIZ_EXERCISE_STARTED, NEW_EXERCISE_POST, NEW_LECTURE_POST, NEW_REPLY_FOR_LECTURE_POST, NEW_COURSE_POST, NEW_REPLY_FOR_COURSE_POST, NEW_REPLY_FOR_EXERCISE_POST, CONVERSATION_NEW_MESSAGE, CONVERSATION_NEW_REPLY_MESSAGE); diff --git a/src/main/resources/templates/haskell/test/readme.md b/src/main/resources/templates/haskell/test/readme.md index a83977cee4fd..bfc95d38aa4f 100644 --- a/src/main/resources/templates/haskell/test/readme.md +++ b/src/main/resources/templates/haskell/test/readme.md @@ -10,7 +10,7 @@ The executables specified in `test.cabal` expect the solution repository checked Moreover, `test.cabal` provides an executable to test the template repository locally. For this, it expects the template repository in the `template` subdirectory. -You can find a script to conveniently setup this folder structure when checking out a new exercise in the [programming exercise setup documentation](https://ls1intum.github.io/Artemis/user/exercises/programming/#setup). +You can find a script to conveniently setup this folder structure when checking out a new exercise in the [programming exercise setup documentation](https://docs.artemis.cit.tum.de/user/exercises/programming/#setup). ## Running Tests diff --git a/src/main/webapp/app/core/about-us/about-us.component.ts b/src/main/webapp/app/core/about-us/about-us.component.ts index 1d6fb1b5fd58..11e6b08d22ad 100644 --- a/src/main/webapp/app/core/about-us/about-us.component.ts +++ b/src/main/webapp/app/core/about-us/about-us.component.ts @@ -24,28 +24,28 @@ export class AboutUsComponent implements OnInit { // Array of tuple containing translation keys and translation values readonly sections: [string, { [key: string]: string }][] = [ - ['exercises.programming', { programmingUrl: 'https://ls1intum.github.io/Artemis/user/exercises/programming/' }], - ['exercises.quiz', { quizUrl: 'https://ls1intum.github.io/Artemis/user/exercises/quiz/' }], - ['exercises.modeling', { modelingUrl: 'https://ls1intum.github.io/Artemis/user/exercises/modeling/', apollonUrl: 'https://apollon.ase.in.tum.de/' }], - ['exercises.text', { textUrl: 'https://ls1intum.github.io/Artemis/user/exercises/textual/', athenaUrl: 'https://github.com/ls1intum/Athena' }], - ['exercises.fileUpload', { fileUploadUrl: 'https://ls1intum.github.io/Artemis/user/exercises/file-upload/' }], - ['exam', { examModeUrl: 'https://ls1intum.github.io/Artemis/user/exam_mode/', studentFeatureUrl: '/features/students', instructorFeatureUrl: '/features/instructors' }], - ['grading', { gradingUrl: 'https://ls1intum.github.io/Artemis/user/grading/' }], - ['assessment', { assessmentUrl: 'https://ls1intum.github.io/Artemis/user/exercises/assessment/' }], - ['communication', { communicationUrl: 'https://ls1intum.github.io/Artemis/user/communication/' }], - ['notifications', { notificationsURL: 'https://ls1intum.github.io/Artemis/user/notifications' }], - ['teamExercises', { teamExercisesUrl: 'https://ls1intum.github.io/Artemis/user/exercises/team-exercises/' }], - ['lectures', { lecturesUrl: 'https://ls1intum.github.io/Artemis/user/lectures/' }], - ['integratedMarkdownEditor', { markdownEditorUrl: 'https://ls1intum.github.io/Artemis/user/markdown-support/' }], - ['plagiarismChecks', { jPlagUrl: 'https://github.com/jplag/JPlag/', plagiarismChecksUrl: 'https://ls1intum.github.io/Artemis/user/plagiarism-check/' }], - ['learningAnalytics', { learningAnalyticsUrl: 'https://ls1intum.github.io/Artemis/user/learning-analytics/' }], - ['adaptiveLearning', { adaptiveLearningUrl: 'https://ls1intum.github.io/Artemis/user/adaptive-learning/' }], - ['tutorialGroups', { tutorialGroupsUrl: 'https://ls1intum.github.io/Artemis/user/tutorialgroups/' }], + ['exercises.programming', { programmingUrl: 'https://docs.artemis.cit.tum.de/user/exercises/programming/' }], + ['exercises.quiz', { quizUrl: 'https://docs.artemis.cit.tum.de/user/exercises/quiz/' }], + ['exercises.modeling', { modelingUrl: 'https://docs.artemis.cit.tum.de/user/exercises/modeling/', apollonUrl: 'https://apollon.ase.in.tum.de/' }], + ['exercises.text', { textUrl: 'https://docs.artemis.cit.tum.de/user/exercises/textual/', athenaUrl: 'https://github.com/ls1intum/Athena' }], + ['exercises.fileUpload', { fileUploadUrl: 'https://docs.artemis.cit.tum.de/user/exercises/file-upload/' }], + ['exam', { examModeUrl: 'https://docs.artemis.cit.tum.de/user/exam_mode/', studentFeatureUrl: '/features/students', instructorFeatureUrl: '/features/instructors' }], + ['grading', { gradingUrl: 'https://docs.artemis.cit.tum.de/user/grading/' }], + ['assessment', { assessmentUrl: 'https://docs.artemis.cit.tum.de/user/exercises/assessment/' }], + ['communication', { communicationUrl: 'https://docs.artemis.cit.tum.de/user/communication/' }], + ['notifications', { notificationsURL: 'https://docs.artemis.cit.tum.de/user/notifications' }], + ['teamExercises', { teamExercisesUrl: 'https://docs.artemis.cit.tum.de/user/exercises/team-exercises/' }], + ['lectures', { lecturesUrl: 'https://docs.artemis.cit.tum.de/user/lectures/' }], + ['integratedMarkdownEditor', { markdownEditorUrl: 'https://docs.artemis.cit.tum.de/user/markdown-support/' }], + ['plagiarismChecks', { jPlagUrl: 'https://github.com/jplag/JPlag/', plagiarismChecksUrl: 'https://docs.artemis.cit.tum.de/user/plagiarism-check/' }], + ['learningAnalytics', { learningAnalyticsUrl: 'https://docs.artemis.cit.tum.de/user/learning-analytics/' }], + ['adaptiveLearning', { adaptiveLearningUrl: 'https://docs.artemis.cit.tum.de/user/adaptive-learning/' }], + ['tutorialGroups', { tutorialGroupsUrl: 'https://docs.artemis.cit.tum.de/user/tutorialgroups/' }], ['iris', { irisUrl: 'https://artemis.cit.tum.de/about-iris' }], - ['scalable', { scalingUrl: 'https://ls1intum.github.io/Artemis/user/scaling/' }], - ['highUserSatisfaction', { userExperienceUrl: 'https://ls1intum.github.io/Artemis/user/user-experience/' }], - ['customizable', { customizableUrl: 'https://ls1intum.github.io/Artemis/user/courses/customizable' }], - ['openSource', { openSourceUrl: 'https://ls1intum.github.io/Artemis/dev/open-source/' }], + ['scalable', { scalingUrl: 'https://docs.artemis.cit.tum.de/user/scaling/' }], + ['highUserSatisfaction', { userExperienceUrl: 'https://docs.artemis.cit.tum.de/user/user-experience/' }], + ['customizable', { customizableUrl: 'https://docs.artemis.cit.tum.de/user/courses/customizable' }], + ['openSource', { openSourceUrl: 'https://docs.artemis.cit.tum.de/dev/open-source/' }], ]; constructor( diff --git a/src/main/webapp/app/exam/manage/exams/exam-checklist-component/exam-checklist.component.html b/src/main/webapp/app/exam/manage/exams/exam-checklist-component/exam-checklist.component.html index 8f7d47d186af..0b4817a2aa9e 100644 --- a/src/main/webapp/app/exam/manage/exams/exam-checklist-component/exam-checklist.component.html +++ b/src/main/webapp/app/exam/manage/exams/exam-checklist-component/exam-checklist.component.html @@ -5,7 +5,7 @@

{{ 'artemisApp.examManagement.checklist.introduction' | artemisTranslate }} - {{ 'artemisApp.examManagement.checklist.linkDescription' | artemisTranslate }} + {{ 'artemisApp.examManagement.checklist.linkDescription' | artemisTranslate }} {{ 'artemisApp.examManagement.checklist.introductionPart2' | artemisTranslate }}

diff --git a/src/main/webapp/app/shared/components/documentation-button/documentation-button.component.ts b/src/main/webapp/app/shared/components/documentation-button/documentation-button.component.ts index 05a5a2de0922..9435a7254d75 100644 --- a/src/main/webapp/app/shared/components/documentation-button/documentation-button.component.ts +++ b/src/main/webapp/app/shared/components/documentation-button/documentation-button.component.ts @@ -34,7 +34,7 @@ export enum DocumentationType { `, }) export class DocumentationButtonComponent { - baseUrl = 'https://ls1intum.github.io/Artemis/user/'; + baseUrl = 'https://docs.artemis.cit.tum.de/user/'; @Input() type: DocumentationType; diff --git a/src/test/javascript/spec/component/documentation-button/documentation-button.component.spec.ts b/src/test/javascript/spec/component/documentation-button/documentation-button.component.spec.ts index d66e439351c2..bb218b917349 100644 --- a/src/test/javascript/spec/component/documentation-button/documentation-button.component.spec.ts +++ b/src/test/javascript/spec/component/documentation-button/documentation-button.component.spec.ts @@ -46,7 +46,7 @@ describe('DocumentationButtonComponent', () => { window.open = mockedOpen; comp.openDocumentation(); - expect(mockedOpen).toHaveBeenCalledWith('https://ls1intum.github.io/Artemis/user/courses/customizable/', expect.anything()); + expect(mockedOpen).toHaveBeenCalledWith('https://docs.artemis.cit.tum.de/user/courses/customizable/', expect.anything()); window.open = originalOpen; }); From e43807f7d04ee1e11e83293c2d025813264f6707 Mon Sep 17 00:00:00 2001 From: Ignacio G Date: Mon, 16 Oct 2023 19:58:29 +0200 Subject: [PATCH 3/5] Fix documentation workflow artifact download --- .github/workflows/docs.yml | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index b6a0633090e0..5d5fb00612b7 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -35,12 +35,11 @@ jobs: build-command: make html dirhtml - uses: actions/upload-artifact@v3 with: - name: Documentation + name: documentation path: docs/_build/html/ # Deployment job deploy: - if: github.ref == 'refs/heads/develop' environment: name: documentation url: "https://docs.artemis.cit.tum.de" @@ -50,7 +49,7 @@ jobs: - name: Download artifact uses: actions/download-artifact@v3 with: - name: www + name: documentation path: public - name: Copy site to server uses: appleboy/scp-action@master From 1c573a69e30e51f449cf359c54c072f0c1ccc70a Mon Sep 17 00:00:00 2001 From: Ignacio G Date: Mon, 16 Oct 2023 20:04:47 +0200 Subject: [PATCH 4/5] Fix typo on documentation workflow --- .github/workflows/docs.yml | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 5d5fb00612b7..253faed637f0 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -40,6 +40,7 @@ jobs: # Deployment job deploy: + if: github.ref == 'refs/heads/develop' environment: name: documentation url: "https://docs.artemis.cit.tum.de" @@ -62,7 +63,7 @@ jobs: proxy_key: ${{ secrets.PROXY_KEY }} proxy_port: ${{ secrets.PROXY_PORT }} source: "public" - target: ${{ secrets.DOCS_HOME }}} + target: ${{ secrets.DOCS_HOME }} - name: Move site to www uses: appleboy/ssh-action@master with: @@ -75,4 +76,4 @@ jobs: proxy_port: ${{ secrets.PROXY_PORT }} script: | sudo rm -rf ${{ secrets.DOCS_WWW }}/* - sudo mv -f public/* ${{ secrets.DOCS_WWW }}}/ + sudo mv -f public/* ${{ secrets.DOCS_WWW }}/ From 56846a4ed49de84cc1c9c254ef55942d9ca46b13 Mon Sep 17 00:00:00 2001 From: Ignacio G Date: Mon, 16 Oct 2023 20:18:15 +0200 Subject: [PATCH 5/5] Fix documentation workflow site setup --- .github/workflows/docs.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 253faed637f0..648be63e90c0 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -75,5 +75,5 @@ jobs: proxy_key: ${{ secrets.PROXY_KEY }} proxy_port: ${{ secrets.PROXY_PORT }} script: | - sudo rm -rf ${{ secrets.DOCS_WWW }}/* - sudo mv -f public/* ${{ secrets.DOCS_WWW }}/ + rm -rf ${{ secrets.DOCS_WWW }}/* + mv -f public/* ${{ secrets.DOCS_WWW }}/