openedx / openedx/openedx-events

Improved organization of event bus specific docs

Open
#279 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
13
Forks
33
Avg merge
14h 37m
Merged PRs (30d)
4

Description

I still think it is better to have the event bus work in this repo than to have the pain of maintaining yet another repo. However, it can be confusing for some what is the difference between events in general and the event bus.

I think it is good that we have the code separated out: https://github.com/openedx/openedx-events/tree/main/openedx_events/event_bus.

However, I'm wondering if we should have a separate directory for event bus specific docs as well? Some alternatives:

  • [Option 1] Add docs/event_bus/how-tos, etc. (Simpler to add to TOC.)
  • [Option 2] Add openedx_events/event_bus/docs/how-tos, etc. (Has some pain involved, but matches OEP-19, for now.)
  • [Option 3] Leave as-is with purely event bus related docs intermingled with the rest.

Note that https://github.com/openedx/open-edx-proposals/issues/530 provides more details about Option 1 and 2, especially in the linked edx-platform issue.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the existing documentation layout and the event-bus code under openedx_events/event_bus. Read the alternatives in this issue alongside open-edx-proposals#530, including its linked edx-platform issue. Done means agreeing on a documentation location and organizing the event-bus-specific docs consistently with that decision.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.