oxfordrse / gutenberg Goto Github PK

they are not showing up in the sidebar. Probably because the challenges are written with quotes:

::::challenge{title="Sorting out references" id=sorting_reference}

presumably this is by accident, need to either prevent this from happening or make it clearer how to undo this

button that goes to the course_material page

My plan is to use openai to make vectors, save them to a local qdrant vector db and search terms are also vectorised and compared to the db.

In some pages/components we are displaying datetimes as UTC strings rather than user's locale (e.g. see EventView.tsx).

Need to find these and change to using toLocaleString()

We currently support github login, could also potentially support oxford SSO? User+pass, does microsoft have info on this?

My goal for gutenberg is for a teaching platform that all RSE groups can use, so it would be good to identify what remains todo before we can start letting other groups know about it and hopefully get feedback / users

• Templatise site-specific pages #59
• Deployment docs #57
• bug #89
• delete event #50

In the admin edit page for an event group: The string representation for the select ui element should include tags to distinguish items in different streams (e.g. Python / C++)

should pop up a dialog saying "are you sure?" so events don't accidentally get deleted!

@steve-crouch has put together a great set of survey questions based on those used at the southampton pilots. It would be good to incorporate them as feedback froms into gutenberg. Perhaps:

1. Pre-event questionair: This might be event specific so would be difficult to implement as I'm not sure how you could automatically generate a form from a supplied desciptor. You sorta can do it using json-schemas, but its fiddly
2. Post-event questionair: Again very event specific so not sure how to implement this. Could just link to a google/microsoft form? Put the link into the event content markdown
3. feedback for eventGroup. This I can see being easier to implement as the questions are very generic, so could put together a standard form. Then each eventGroup has a link to the feedback from for that eventGroup, and stored in the dbase linked to that particular eventGroup

I quite like how ChatGPT renders code blocks, e.g. with a small header that contains the language, and on the right a "copy code" button.

when you click select and the sidebar opens, the select button is still visible over the sidebar, should be underneath it

challenges should have id=<id>, where <id> is the id from the challenge directive in the material. This way we can link to them from elsewhere

it seems to be counting everyones solved problems in a given section

need to order by date

1. select an active event
2. unselect active event
3. refresh the page and the original event is still active

look at this for ideas: https://www.prisma.io/blog/backend-prisma-typescript-orm-with-postgresql-deployment-bbba1ps7kip5

• students should see their progression through the material
• Instructors should see problem data submitted by students

In Sidebar:

• Instructors :"x%" next to each item indicating the average percentage complete of each item across the enrolled students. If the item has no problems this is not displayed
• Students: "a/b" next to each item indicating the number of complete problems in each item. If the item has no problems this is not displayed. If a section is complete it changes color to green with a tick instead.

On Problem:

• Instructors: eye icon that opens a dialog showing full list of responses
• Instructors: tick icon and "a/b" indicating number of students who have completed this problem
• Instructors: easy / average / hard colored amber / green / red with tooltip showing "a/b" difficulty

need a timeline summary on the main event page. This page is viewable by those who are not yet enrolled, so shouldn't contain locations or any other info we want to restrict

now that we have CI, we need badges!!!

We've started putting in markdown slide material in some courses (under slides subdir). Would be good if gutenberg rendered these in some format (e.g. reveal.js)

• buttons on challenges not showing up in light mode
• some images don't work well in light mode

deployment step in test.yml is empty, need to fill this in to deploy to train.oxrse.uk (if other site exist, southampton, should have other jobs to deploy there as well? @steve-crouch)

note that we have depoy.yml to deploy to github static pages, this should be merged into test.yml perhaps?

54:48 Error: Using target="_blank" without rel="noreferrer" (which implies rel="noopener") is a security risk in older browsers: see https://mathiasbynens.github.io/rel-noopener/#recommendations react/jsx-no-target-blank

Would it make sense to have a more responsive web layout for material pages, where the content width resizes proportionally to the browser width? This may make sense for learners (and those delivering instructor-led sessions) with larger monitors.

students should be able to ask questions on material and receive responses, each CommentThread row has:

• event (foreign key to Event, required)
• eventgroup (foreign key to EventGroup, optional)
• section (string, link to material page, blank if not linked to material)
• problem (string, link to problem, blank if not linked to a problem)
• text_ref (string, text within section that this comment refers to, includes surrounding text, blank if not linked to material)
• text_ref_start (optional, index within text_ref that indicates start of text that this comment refers to)
• text_ref_end (optional, index within text_ref that indicates end of text that this comment refers to)

each Comment has:

• markdown for content (string, required)
• comment (foreign key, required)
• next_comment (foreign key to Comment, optional)

In UI:

• users can add comments to event and eventgroup pages
• users can highlight text in the material (or select a paragraph, this might be more feasible) and add a comment along with some markdown
• users can see and respond to comments if they have selected (and enrolled in) its event

As part of the Aug 2023 pilot, I've recorded some notes on deployment to Ubuntu 22.04 that we can convert to markdown as a basic guide.

Consider adding backwards and forwards navigation icons (perhaps at the bottom or top of the episode content pages) so learners and instructors can progress to previous and next episodes more quickly.

can course pages be added to the sidebar. need to check this and do any fixes that are required

but sometimes if you refresh the page it fixes itself, so might just be a transient front-end thing

• remove cross-theme links at toplevel
• remove sections from top level
• add cross-course links at course level

It would be nice to have a templatised front-page layout in some way, to make it easier for new deployers to customise to their own needs - and then reference it in the deployment instructions.

in admin view of event

When you go deep down a material tree the navbar gets destroyed on mobile devices, we should make it collapse on small screens, rprobably keep the right hand side icons but make the material nav into a burger menu

It would be convenient to have a heading/exercise paragraph selector for copying direct links to sections or exercises to send to others (like with the Carpentries formatting style). This would be particularly useful for instructors referencing particular sections or challenges for learners.

So we can implement admin UI / endpoints (e.g. creating / editing an event, adding users to an event)

we've got various useEffect warnings for dependencies, need to tidy up these

UNIVERSE-HPC/course-material#20

fail
pass

I thought this was an issue with updating the node version to 18 to but I can semi-reliably recreate this on node 16 as well. It seems to happen less often with cypress 13+ (which requires node>20), working every time for me locally and well at least once on the CI, though with 1 fail too.

Stack overflow seems to suggest this error should just be caught and ignored as it is meaningless but making an issue just in case this is inaccurate.

need info in README.md about cloning the course material

@martinjrobins looking here:
https://gutenberg.fly.dev/material/software_architecture_and_design/object_orientated/classes

First challenge has two solution blocks, and the second one doesn't display anything when opened.

Do you see this behaviour too?

There are some form components in Challenge.tsx that could be separate components for re-useability

On the materials overall page, below the diagram it might be useful to have the materials rendered as a bullet point-style list (e.g. by module/lesson) which links to the modules/lessons in the material. This may become more important as more material is added to ease navigation.

https://nextjs.org/docs/pages/building-your-application/data-fetching/incremental-static-regeneration

could put a cron job in the docker container to continually refresh material, and use ISR to update the pages