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

Add keywords vs. categories to user docs #889

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,9 @@
- Usage of caches for NPM speedup
[#883](https://github.com/nextcloud/cookbook/pull/883) @christianlupus

### Documentation
- Added clarification between categories and keywords for users
[#889](https://github.com/nextcloud/cookbook/pull/889) @MarcelRobitaille

## 0.9.9 - 2022-01-13

Expand Down
Binary file added docs/user/assets/keywords-and-categories.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/user/assets/keywords-and-categories.xcf
Binary file not shown.
25 changes: 23 additions & 2 deletions docs/user/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

### Importing from a Website

Recipes can be imported by entering the URL to a recipe in the text-input field in the top right area of the Cookbook app.
Recipes can be imported by entering the URL to a recipe in the text-input field in the top right area of the Cookbook app.

<img src="assets/create_import.png" alt="Recipe-import field" width="200px" />

Expand All @@ -23,4 +23,25 @@ Currently, the only way to share recipes is by sharing the Nextcloud folder that

### Public Sharing

At the moment it is not possible to share a public link to a recipe.
At the moment it is not possible to share a public link to a recipe.

## FAQ

### When should I use keywords and when should I use categories to organize my recipes?

The use of keywords and categories is entirely up to you.

The primary difference between the two is that a recipe can only have a single category,
but may have many keywords.
In other words,
categories are a 1:N relationship while keywords are an N:M relationship.

Categories can be accessed more directly than keywords,
as they appear in the sidebar.
By clicking a category in the sidebar,
you can quickly narrow down recipes to a certain class, like "Main dishes" or "Deserts".
Then, keywords can be used to further narrow down the selection
with tags like "vegetarian" or "easy".
In this way, categories are used for rough filtering and keywords are used for fine filtering.

![Example workflow using categories for rough filtering and keywords for fine filtering](assets/keywords-and-categories.png)