search

buggyrace / buggy-race-server

Race server and supporting material for running a "Buggy Racing" Python programming project
https://www.buggyrace.net
Other
1 stars 0 forks source link

General comments & typos #200

Open mandyWW opened 5 months ago

mandyWW commented 5 months ago
mandyWW commented 5 months ago
mandyWW commented 5 months ago

Can we have anchor elements for the headings in the buggy server poster page so it's easier to link to parts of the poster documentation? I feel it's not clear that they need to record their progress as they go along so wanted to link to the section "Storing texts on this race server". Would also be useful to make this very clear on the main tasks page and at the end of every task else there is a risk people won't log in and won't record their progress.

davewhiteland commented 5 months ago
  • Unclear that you need to redeploy when changing config e.g. https://rhul.buggyrace.net/admin/settings/github - would be helpful to have a warning at the top of each page that you need to do this rather than assume it will pick up immediately.

This behaviour is configurable: if IS_SHOWING_RESTART_SUGGESTION is set to Yes (in the "Server" group of config settings) then a warning is shown. The reason why it's not automatically on is we didn't seem to need restart for changes to pick up, but this was never investigated thoroughly (it was unexpected, because originally I assumed a redeploy would always be needed). Really need to determine when a redeploy is needed (or if it always is).

davewhiteland commented 5 months ago

Can we have anchor elements for the headings in the buggy server poster page so it's easier to link to parts of the poster documentation?

Yes, there should be anchor elements on all headings on the server pages: see #154

davewhiteland commented 5 months ago

Would also be useful to make this very clear on the main tasks page and at the end of every task else there is a risk people won't log in and won't record their progress.

Yup, especially as IS_STORING_STUDENT_TASK_TEXTS is a config setting, so the server could add a message saying "remember to record how you approached or solved this in a task text" [linking to the task text input] to the task descriptions (so it doesn't need to be added to each task text manually)

davewhiteland commented 5 months ago
  • Link to .../tech_notes/localhost does not work

oof yes it should be tech-notes/localhost (hyphen not underscore) — looks like it's only wrong when linking to the page about localhost (dunno why it's only that one), in about 9 places (!)

mandyWW commented 4 months ago

Task 1-TEMPLATE typo "It's up to you What data from the specs do want to display"

mandyWW commented 4 months ago

Type in Buggy Server - "Helful hints to help students understand the problem and perhaps concepts around it"