openedx / openedx/openedx-events

Improve docs for when and how to add events

Open
#269 2 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

This would likely affect:
https://docs.openedx.org/projects/openedx-events/en/latest/how-tos/creating-new-events.html

A quote from someone about something that wasn't obvious from the docs:

I think what I’m hearing is let’s not be stingy about creating new events even if it only has one use today

I think it would be great to clarify that events that only serve a single use case (to start) is not only completely acceptable, but the most common situation. That said, thinking about future consumers might help influence the event design, so it is useful to consider as well.

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

Open docs.openedx.org/projects/openedx-events/en/latest/how-tos/creating-new-events.html and read the guidance on creating new events. Clarify that events serving a single use case are acceptable and common, while future consumers can still inform event design. Done means the page states both points clearly.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
50/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.