Hackathon XXVI Ideas

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:

Possible doc project categories:

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.
- Examples:
  - 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.
- Examples:
  - 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.
- Examples:
  - 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.
Repo-by-repo work: fix a repo at a time.
- Examples:
  - Fix http://readthedocs.org projects that aren’t building successfully now.
  - Add docs CI to repos that don’t have it
Page-by-page work: fix a page at a time, possibly actually write some docs.
- Examples:
  - Improve a “root” page to help people find things.
  - Add a new “root” page for a new part of our audience.
  - Identify some wrong pages, even without fixing them yet.
  - Fix some wrong pages.
  - Correct a README.rst in a repo.

Other resources:

/wiki/spaces/HACK/pages/3022619011 pointers to documentation things that could be helpful
Run Book for Debugging/Fixing Docs and Adding CI
Four kinds of documentation: https://documentation.divio.com/
/wiki/spaces/HACK/pages/3040379463 is a great place to look at for the different kinds of people who use docs and how you might make their life better.

Idea Name	Idea Description	Necessary Skills	Proposer Name	Committed Project? (y/n)
Zoom timer	a Zoom plugin that tracks the cumulative speaking time of each participant	coding	Albemarle (Deactivated)	not yet
Wiki Nudger	Go through the wiki and get a list of all the pages ordered by when they were last updated. Can probably start with https://github.com/nedbat/wikicrawl and make improvements.	coding	Ned Batchelder (Deactivated)	No
Build the Docs	There are many repos that are currently failing to build and publish their docs to ReadTheDocs. Fix the issues, but also add a test to CI to detect breaking the docs so we can catch it earlier. Run Book for Debugging/Fixing Docs and Adding CI List of Repos with Broken Docs edX Credentials: https://github.com/edx/credentials Owning Team: aperture Repo Priority: medium Django Config Models: https://github.com/edx/django-config-models Owning Team: arch Repo Priority-bom: medium django-user-tasks: https://github.com/edx/django-user-tasks Owning Team: arch Repo Priority-bom: low edX Ecommerce: https://github.com/edx/ecommerce Owning Team: revenue Repo Priority: high edX Automated Communications Engine (A.C.E.): https://github.com/edx/edx-ace Owning Team: engage Repo Priority: medium edX Insights: https://github.com/edx/edx-analytics-dashboard Owning Team: cosmonauts Repo Priority: low edX Data Analytics API: https://github.com/edx/edx-analytics-data-api Owning Team: cosmonauts Repo Priority: low edX Analytics Pipeline Reference: https://github.com/edx/edx-analytics-pipeline Owning Team: data Repo Priority-de: low edx-drf-extensions: https://github.com/edx/edx-drf-extensions Owning Team: arch Repo Priority-bom: high Open edX Enterprise Service Documentation: https://github.com/edx/edx-enterprise Owning Team: titans Repo Priority: high edX Open Response Assessments: https://github.com/edx/edx-ora2 Owning Team: gta Repo Priority: medium edX Enrollment API: https://github.com/edx/edx-platform Owning Team: no Repo Prioritylonger maintained edX Submissions API: https://github.com/edx/edx-submissions Owning Team: gta Repo Priority: medium event-tracking: https://github.com/edx/event-tracking Owning Team: data Repo Priority-de: low edX Opaque Keys API: https://github.com/edx/opaque-keys Owning Team: tnl Repo Priority: high	coding	Feanil Patel (Deactivated)	No
Review Docs	Review https://edx.readthedocs.io/projects/edx-developer-docs/en/latest/ which is built from https://github.com/edx/edx-developer-docs . Add links to more docs, update the docs, or add more based on what you believe a developer new to Open edX should know about.		Feanil Patel (Deactivated)
Make the Hackathon Badge