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

How to create a filter from start to finish #183

Open
Tracked by #180
mariajgrimaldi opened this issue Jun 24, 2024 · 0 comments
Open
Tracked by #180

How to create a filter from start to finish #183

mariajgrimaldi opened this issue Jun 24, 2024 · 0 comments
Labels
documentation Relates to documentation improvements

Comments

@mariajgrimaldi
Copy link
Member

mariajgrimaldi commented Jun 24, 2024

Description

Some comments I've gathered from the community survey on the challenges/suggestions section:

I would only improve the documentation a little bit. For example, in the section on creating a filter it talks about two different filters, which may cause confusion. I think it would be good to show an example of a filter implemented from start to finish, which contains all or at least most of the functionality offered by the library. additionally, the openedx-filters-samples repository has a great variety of examples, but it shows the filter creation part, but not (I think) the filter usage which is also important.

@mariajgrimaldi mariajgrimaldi added maintenance Routine upkeep necessary for the health of the platform documentation Relates to documentation improvements labels Jun 24, 2024
@mariajgrimaldi mariajgrimaldi changed the title Documentation: how to create a filter from start to finish How to create a filter from start to finish Jun 24, 2024
@mariajgrimaldi mariajgrimaldi removed the maintenance Routine upkeep necessary for the health of the platform label Jun 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Relates to documentation improvements
Projects
None yet
Development

No branches or pull requests

1 participant