Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve documentation for events across Open edX releases #356

Closed
mariajgrimaldi opened this issue Jun 24, 2024 · 1 comment
Closed

Improve documentation for events across Open edX releases #356

mariajgrimaldi opened this issue Jun 24, 2024 · 1 comment
Labels
maintenance Routine upkeep necessary for the health of the platform

Comments

@mariajgrimaldi
Copy link
Member

Description

Developers often encounter difficulties debugging events-related issues due to insufficient or unclear documentation across different Open edX releases. This lack of detailed documentation makes it challenging to determine the existence and behavior of specific events in various platform versions.

Expected Result

  • Comprehensive and clear documentation for events across all Open edX releases.
  • Easy accessibility and searchability of event documentation to facilitate efficient debugging.
  • Timely updates to documentation with each new release to reflect changes and additions accurately.

Possible Solutions

Release versioning documentation for events:

  • Maintain detailed documentation that outlines the events available in each Open edX release.
  • Ensure that the documentation includes descriptions, usage examples, and any relevant configuration details.
  • Update the documentation promptly with each new release to ensure it accurately reflects the current state of the platform.
@mariajgrimaldi mariajgrimaldi added the maintenance Routine upkeep necessary for the health of the platform label Jun 24, 2024
@mariajgrimaldi
Copy link
Member Author

Duplicated issue, closing in favor of #364

@mariajgrimaldi mariajgrimaldi closed this as not planned Won't fix, can't repro, duplicate, stale Jun 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
maintenance Routine upkeep necessary for the health of the platform
Projects
None yet
Development

No branches or pull requests

1 participant