Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Development: Add documentation for standardized competencies #8711

Conversation

rstief
Copy link
Contributor

@rstief rstief commented Jun 2, 2024

Checklist

General

Client

  • I strictly followed the client coding and design guidelines.
  • Following the theming guidelines, 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 translated all newly inserted strings into English and German.

Motivation and Context

We want all Artemis features to have good documentation to users can easily look up how to use them.

Description

This PR adds documentation for the features added as part of my thesis:

  • Standardized Competencies
  • Generating Competencies with Iris
  • Improvements to the competency import

It also improves and updates the existing documentation for adaptive learning.

Finally, it adds documentation buttons to multiple views so users can directly visit documentation from Artemis.

Steps for Testing

  1. View the documentation and see that it is clear, correct and has no formatting errors
  2. Go to the following views and see that the documentation buttons are displayed properly (next to the header) (test on ts3):
    1. Standardized Competency Management
    2. Standardized Competency Import
    3. Competency Generation
    4. NOTE: The links in the buttons do not work (as the documentation pages are not yet included in the Artemis docs). You can however see that the URLs match those of the online docs of this PR.

Testserver States

Note

These badges show the state of the test servers.
Green = Currently available, Red = Currently locked






Review Progress

Performance Review

  • I (as a reviewer) confirm that the client changes (in particular related to REST calls and UI responsiveness) are implemented with a very good performance

Code Review

  • Code Review 1
  • Code Review 2

Manual Tests

  • Test 1
  • Test 2

Test Coverage

unchanged.

Summary by CodeRabbit

  • Documentation
    • Updated the Adaptive Learning documentation to emphasize competencies and personalized learning paths.
    • Introduced a new section for instructors on managing adaptive learning, including competency management and learning path creation.

@github-actions github-actions bot added the client Pull requests that update TypeScript code. (Added Automatically!) label Jun 2, 2024
@github-actions github-actions bot added the tests label Jun 2, 2024
@rstief rstief changed the title Adaptive Learning: Add documentation for standardized competencies and improve existing documentation Adaptive learning: Add documentation for standardized competencies and improve existing documentation Jun 3, 2024
@rstief rstief marked this pull request as ready for review June 11, 2024 08:35
@rstief rstief requested a review from a team as a code owner June 11, 2024 08:35
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 4

docs/user/adaptive-learning.rst Outdated Show resolved Hide resolved
Copy link
Contributor

@marlon-luca-bu marlon-luca-bu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

reapprove

Copy link
Contributor

@Jan-Thurner Jan-Thurner left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for implementing the changes. LGTM

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 3

Copy link
Member

@BBesrour BBesrour left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

re-approve

Copy link
Collaborator

@MaximilianAnzinger MaximilianAnzinger left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maintainer approved

@MaximilianAnzinger MaximilianAnzinger added maintainer-approved The feature maintainer has approved the PR and removed ready for review labels Jun 13, 2024
@krusche krusche changed the title Adaptive learning: Add documentation for standardized competencies and improve existing documentation Development: Add documentation for standardized competencies and improve existing documentation Jun 13, 2024
@krusche krusche changed the title Development: Add documentation for standardized competencies and improve existing documentation Development: Add documentation for standardized competencies Jun 13, 2024
@krusche krusche added this to the 7.2.1 milestone Jun 13, 2024
@krusche krusche merged commit d5c4a8c into develop Jun 13, 2024
34 of 36 checks passed
@krusche krusche deleted the chore/adaptive-learning/add-standardized-competency-documentation branch June 13, 2024 22:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
client Pull requests that update TypeScript code. (Added Automatically!) component:AdaptiveLearning documentation maintainer-approved The feature maintainer has approved the PR tests
Projects
Archived in project
Status: Done
Development

Successfully merging this pull request may close these issues.

9 participants