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

Database Refactor #18

Open
wants to merge 8 commits into
base: master
Choose a base branch
from
Open

Database Refactor #18

wants to merge 8 commits into from

Conversation

erikautenrieth
Copy link
Collaborator

@erikautenrieth erikautenrieth commented Apr 6, 2024

Instead of having numerous branches with templates for students, graders, and tests, now numerous folders can be placed under the "data" folder. The names of these folders will be displayed in the dropdown menu as follows:

test

The workflow should proceed as follows:

  • Students and new users always have setMode("students") enabled by default and can only see the data from the StudentTemplate folder."
  • As soon as "setMode("grader") is entered into the console, data from the "GradeTemplate" becomes visible, plus the dropdown menu to switch between other templates.
  • Once in grader mode, switching between the templates is possible. Please note that the grader table is always displayed. However, it is not visible to students in student mode.

ToDo before merging:

  • delete old functions
  • change link in the "getSubfolderNamesFromGithub()" function
  • In the references.json files, there are many redundancies in the URLs that could be simplified, but it would require a slight change to the structure

Copy link
Owner

@karlkirschner karlkirschner left a comment

Choose a reason for hiding this comment

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

Hey Erik,
This looks good to me, but I have one thought. For both the GraderTemplate and StudentTemplate, the references.json files are calling different .json files. For example:

  • "url":"data/GraderTemplate/criteria/pandas.json"
  • "url": "data/StudentTemplate/criteria/pandas.json"

I wonder if it would make more sense to have them both reference the same pandas.json file. This would keep the overall organization and tracking changes that need to be made (or were done) easier in the future. (I did think about if it would be good to have separate files, and an argument could be made for that - but in the long run, I think it would be easier to K.I.S.S.) If you have a good arguement otherwise, I am all ears.

Bests,
Karl

P.S. When I in the database_refactor branch locally (on my computer) and I load index.html in my Firefox, I obtain errors which seem to arise from not have the assignment json files in the data folder. Or have you already implemented changes that will not allow the work to be loaded on a local computer?

@erikautenrieth
Copy link
Collaborator Author

Hey,

I wasn't sure here because Minh said that there can be differences between the student and the grader view for some criteria like (general, numpy, miscellaneous ...).

  • If there were no differences at all, we would only need one folder for all criterias and then have "n" references.json files for students, graders and tests.

  • If some criteria are always the same but some are different, we could put the constant ones in a folder and leave the implementation as it is.

Sorry for the error, I forgot to push the ciritrias for StudentTemplate to GitHub. Should be ok now.

@karlkirschner
Copy link
Owner

I wasn't sure here because Minh said that there can be differences between the student and the grader view for some criteria like (general, numpy, miscellaneous ...).
If there were no differences at all, we would only need one folder for all criterias and then have "n" references.json files for students, graders and tests.
If some criteria are always the same but some are different, we could put the constant ones in a folder and leave the implementation as it is.

I think having multiple versions of a form (student vs grader) will only make things more complicated. I know that I have added specific feedback to the form when I was grading, but it was only a few bullet points at any given time. In the future, what ever specific that I need to include, I can probably do through a homework-specific tab at the bottom of the page.

I like the transparency of having only be one criteria that both the students and the graders can view - apart from the grading/marks floating box, which should only be for the graders. So, one folder for all criteria should be good.

Do you need any other feedback - or do you want to wait for Minh to look things over. Otherwise, I can merge when you tell me to.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants