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

Enhance documentation across different Open edX releases #178

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

Enhance documentation across different Open edX releases #178

mariajgrimaldi opened this issue Jun 24, 2024 · 1 comment
Labels
enhancement Relates to new features or improvements to existing features maintenance Routine upkeep necessary for the health of the platform

Comments

@mariajgrimaldi
Copy link
Member

Description

Developers often encounter difficulties determining if a specific filter exists in a particular Open edX release. This lack of clarity complicates the debugging process and reduces efficiency, as developers must spend additional time and effort verifying the existence of filters across different platform versions.

Expected Result

  • Comprehensive, clear, and accessible documentation that details the availability of filters in each Open edX version.

Possible Solutions

Release Versioning Documentation:

  • Maintain and regularly update documentation that details all filters available in each version of Open edX.
  • Ensure the documentation is easily accessible and searchable for developers.
  • Include information such as filter names, descriptions, and any relevant parameters or configurations.
@mariajgrimaldi mariajgrimaldi added maintenance Routine upkeep necessary for the health of the platform enhancement Relates to new features or improvements to existing features labels Jun 24, 2024
@mariajgrimaldi
Copy link
Member Author

Closed in favor of #187

@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
enhancement Relates to new features or improvements to existing features maintenance Routine upkeep necessary for the health of the platform
Projects
None yet
Development

No branches or pull requests

1 participant