ls1intum / Artemis

Artemis - Interactive Learning with Automated Feedback
https://docs.artemis.cit.tum.de
MIT License
456 stars 274 forks source link

Inconsistent and inaccurate naming of course enrollment #6351

Open julian-christl opened 1 year ago

julian-christl commented 1 year ago

Issue

If set up correctly, Artemis allows users to enrol themselves in courses. Incorrectly, however, this is named "registration". We already have reserved the word "registration" for the functionality the user uses to sign up to Artemis (if configured).

Additionally, the German and English versions differ from each other: English uses "registration", and German uses "Anmeldung", which corresponds to "sign in"/"login".

Suggestion

I suggest consistently using the words enroll (ENG) and einschreiben (GER) when working with this functionality. This increases the consistency between both language versions and makes our language more precise.

It affects code and template

UPDATE

After considering suggestions from Julian, I have accepted his idea to break this large issue into subtasks as it almost reaches 2000 places in code to review/change spaning from server to client side. I have already covered the client side (eg /src/main/webapp) including the comments etc. Remaining are:

Subtasks

Keep in mind to change only instances regarding course registration (now enrollment) and do not change for example exam registration, tutor group registration etc...

krusche commented 1 year ago

Good suggestion. Let's fix that directly. @pal03377 is working on this at the moment. Could you directly implement it in your current PR?

julian-christl commented 1 year ago

I created the issue because he didn't want to do it in the PR.

Honestly, I think doing it in another PR would be better. Easier to focus on the relevant code segments to review.

dearjasmina commented 1 year ago

Hello @krusche, I have been working on this issue and, as pointed out replaced key & value pairs in the following matter:

However, I have also noticed that variables, components,... are also named register instead of enroll. These span over a lot of files that would require change if it is desired to do so. Should I change them as well or not?

julian-christl commented 1 year ago

@dearjasmina I'll allow myself to answer as I created the issue :D The intention was to fix this system-wide. This includes everything UI-related, but also variables, tests, etc. Because if we don't have consistency everywhere, you just have to wait for someone to read the variable and create some new text using the wrong term. And then we have the same issue once again.

However, it's up to you if you want to create multiple smaller PRs that tackle only a part of the issues so you get faster reviews and faster testing or if you want to, create a larger PR solving the issue at once. Just don't close the issue before it's solved completely :)

Feel free to edit the issue and add different categories that need renaming (e.g. Translation, different classes, different tests, etc). This way, if you decide that you only want to do a portion, you can check everything you've done and someone else can take over.