Please keep in mind that this page is shared publicly with the external Open edX community and that confidential information (learner data, business plans, etc.) should not be shared in connection with any Hackathon project, whether on this page or in shared Slack channels or elsewhere.
This page is intended to share all ideas for Hackathon projects regardless of whether the ideator will be working on it during the Hackathon or not.
Some ideas from previous hackathons that are up for grabs here: LINK. Note: If you want to work on an idea from this list, please move it to the Confluence page. If you have a new idea, please add it to this Confluence page.
For documentation projects, here are some possible categories of work:
Investigate new technologies: look for new ways to write and publish information.
Note: Legal wants to do vendor reviews even before signing up for free trials.
Is there something better than Confluence?
Is there a better all-docs search than https://docs.edx.org/search ? The current search is only over public documents. Is there something that could also work on private documents?
Is there a WYSIWYG .rst editor that could make it easier for people to edit RST docs?
What’s the best third-party maintained Sphinx theme to replace our custom one?
Build tools: create things that will make producing, finding, using, updating, or fixing docs better.
Wiki spider to find stale wiki pages
A “bad page inbox”: how can we make it as easy as possible for anyone (in or out of edX) to alert us to wrong/bad/out-of-date pages?
Measure some docs quality stats: how often are pages updated?
Process improvements: ways to change how we work to help keep docs good.
What does ownership of docs mean?
Spell out how best to do continuous integration for the docs in a repo.
Establish a tag/label/marker of some kind to tag pages that need attention.
What REST APIs that are available to people using javscript on course pages, and how do we get to them? For instance, could we pull a list of the other courses someone’s enrolled in?
JS On the Page
Help Center consolidation
Is there any way to consolidate/merge responses at the edX Help Center? I remember some questions having multiple overlapping responses (and occasionally old out-of-date ones).
What is the structure of the video controller object? I’ve hooked into it myself in the past via JS, but it was some serious code archaeology, and making this easier would enable more people to build cool tools.
MathJax for PwDs
MathJax has a major upgrade (from 2.x to 3.x) out, and it is more interactive and natively accessible than the last version. The small MathJax team has done an admirable job attending to accessibility concerns in design and development of v3. But they haven’t documented those efforts at all. So I want to write a How to Use MathJax guide for People with Disabilities. This may eventually be included in a larger How to Learn Online for PwDs course.
writing, UDL, or instructional design might be helpful
Make the Hackathon Badge
Como se dice… i18n?
We will be working to consolidate and organize information relevant to edX’s current language support capabilities. This will become an information oriented reference that will support any potential i18n work in the future and serve as a source for ideas on where edX can go next for i18n.
Topics of consideration include, but are not limited to, current language support across our systems, user language preference data, the number of untranslated strings in Transifex.
Access to Transifex
@Mariana Hernandez Barroso@Carla Duarte
Como se hace… i18n?
We’re looking to understand the technical landscape of translations at edX. We want to consolidate, organize, and improve current technical documentation wherever possible. In a broad sense, we want to understand where we are today and what opportunities to improve translations lie ahead.
Topics of consideration include, but are not limited to, how we enable a new language in a service, what translation infrastructure exists for each service, and discovery of new translation tech.
Coding, technical documentation, access to Transifex
@Mariana Hernandez Barroso@Carla Duarte
Form a Documentation Working Group
Create a charter and operational plan for a working group to continuously improve our documentation.
Note: doing this does not mean you are committing to run the working group, or even be a member!
Process thinking, organizational detail.
Organization in itself is a form of documentation!
edx-platform has dozens of Django apps spread across different folders. Some of the apps are redundant, while others are bloated. In this hackathon, I/we would aim to make edx-platform more self-documenting by moving, renaming, refactoring, and documenting apps throughout the monolith.
This clean-up would be done with an eye towards strengthening logical monolith boundaries, especially those between the Learning (LMS) domain, Authoring (CMS) domain, and supporting domains like Authn.