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

General comments & typos #200

Open
mandyWW opened this issue Mar 20, 2024 · 8 comments
Open

General comments & typos #200

mandyWW opened this issue Mar 20, 2024 · 8 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@mandyWW
Copy link
Collaborator

mandyWW commented Mar 20, 2024

  • 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.
@mandyWW mandyWW added the documentation Improvements or additions to documentation label Mar 22, 2024
@mandyWW
Copy link
Collaborator Author

mandyWW commented Mar 25, 2024

  • Link to .../tech_notes/localhost does not work

@mandyWW
Copy link
Collaborator Author

mandyWW commented Mar 25, 2024

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
Copy link
Collaborator

  • 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
Copy link
Collaborator

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
Copy link
Collaborator

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
Copy link
Collaborator

  • 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 (!)

@davewhiteland davewhiteland self-assigned this Mar 25, 2024
@mandyWW
Copy link
Collaborator Author

mandyWW commented Apr 29, 2024

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

@mandyWW
Copy link
Collaborator Author

mandyWW commented Apr 29, 2024

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

davewhiteland added a commit that referenced this issue Aug 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants