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

Category listing #11

Open
c-martinez opened this issue Apr 2, 2024 · 4 comments
Open

Category listing #11

c-martinez opened this issue Apr 2, 2024 · 4 comments
Labels
enhancement New feature or request

Comments

@c-martinez
Copy link

At the moment, the metadata of the modules includes the category keyword, which is used to define in which category the module will appear. But if the category does not exist, it will silently fail (for example if your category is Getting started instead of Getting Started).

As a user, it would be nice if "unknown categories" were added automatically to the list of existing categories (maybe thrown at the end).

@JaroCamphuijsen JaroCamphuijsen removed their assignment May 28, 2024
@JaroCamphuijsen JaroCamphuijsen added the enhancement New feature or request label May 29, 2024
@JaroCamphuijsen
Copy link
Collaborator

I would like to review the whole categorization and filtering of modules.
An interesting example I find very useful is the github projects filtering, grouping and sorting:

In the example below, I filtered issues on being in the "previous iteration" (an iteration is a period of time you define that you work on a project, like a sprint or a coworking day), I grouped them by repository (where the issue belongs to) and sorted them according to their "priority" (which is just a numerical label between 1 and 4).

image

I think this flexibility of filtering, grouping and sorting is too complicated for us, but it is nice as an example.
In our case the filtering could be based on a label, which defines an interesting subset, like "masterclass", "life science", "technology" etc. Sorting could be according to a preset "order" much like we currently do for the chapters, and grouping might still be according to the current categories, or using some other grouping. Perhaps having a set of useful "collections" which have preset filters, groupings and sortings is what we actually need.

These could perhaps be defined in the config.json file e.g.:

"collections": {
  "masterclass": {
    "filter": "masterclass",
    "sort": "order",
    "group": "category"
  }
}

These collections could then be listed in a clear spot on the main page.
Or is this already too complicated and do we just need the proper labels to be able to filter and get rid of all the complexity?

@JaroCamphuijsen
Copy link
Collaborator

@raar1 @c-martinez @Cmurilochem what do you think?

@c-martinez
Copy link
Author

I am not sure if the collection filtering would solve the initial problem: I add a new module, but mistype the category name. As a user I only see the new module is not showing at all, and have no idea where the problem is.

I am not against if it is a feature that would be useful in other circumstances. I would just ask what happens if I mistype the category name? Where does my module ends up? If it doesn't show up at all (because it doesn't match the filter), I think the user would still find it frustrating.

@JaroCamphuijsen
Copy link
Collaborator

yes @c-martinez sorry, I understand the original issue that you mentioned and I agree it should definitely be solved. I just wanted to mention that we might want to rethink and replace the whole category grouping system or at least extend it with the ability to let the user filter, group and sort modules themselves. But I actually think that it belongs in a different issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants