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

Update user documentation #936

Merged
merged 7 commits into from
Mar 28, 2022
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
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@
- Refactor the code for image handling to make it testable
[#933](https://github.com/nextcloud/cookbook/pull/933) @christianlupus

### Documentation
- Enhanced the user doumentation by adding some starter's information
[#936](https://github.com/nextcloud/cookbook/pull/936) @zorglubu


## 0.9.11 - 2022-03-28

Expand Down
2 changes: 2 additions & 0 deletions docs/.bundle/config
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
---
BUNDLE_BUNDLE_PATH: "vendor/bundle"
1 change: 1 addition & 0 deletions docs/_config.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
theme: jekyll-theme-slate
repository: nextcloud/cookbook
exclude:
- "Makefile"
- "vendor/"
Expand Down
60 changes: 37 additions & 23 deletions docs/user/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,42 @@
# Usage Documentation

## Starting with Cookbook

Before creating your first recipe, you should decide where your recipes and pictures will be stored.
All files will be accessible in your Nextcloud file manager.
That allows you to access your files with 3rd party applications by using the usual Nextcloud file synchronization app/client.

By default, the folder will be a localized folder in your users main folder.
You can simply check in the *Parameters* of Cookbook, in the low left corner, in which directory the recipes will be stored on Nextcloud.

## Adding a recipe

Click on the button *Create a recipe* and add a title and any useful information.
If a block of information is empty, it won't be displayed in Cookbook.

An image may be added to the recipe. There are multiple ways to get this done:
- The image can be previously stored on your Nextcloud instance. Click on the icon on the right of the image field, and select the image.
- The image can be loaded from a URL. Just type or paste the URL in the field. The cookbook app will download and use the image.

Links may be added to other recipes in the fields of *Description*, *Tools*, *Ingredients*, and *Instructions*:

- Type a `#` and select, in the pop up list, the recipe to be linked.

## Using keywords and categories

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)

## Importing Recipes

Expand All @@ -11,7 +48,6 @@ Recipes can be imported by entering the URL to a recipe in the text-input field

However, the Cookbook app requires the recipe site to support the [schema.org recipe standard](http://www.schema.org/Recipe)’s JSON+LD meta data. Those websites which don't provide the required data are currently not supported.


## Sharing Recipes

### Sharing with another Nextcloud User
Expand All @@ -20,28 +56,6 @@ Currently, the only way to share recipes is by sharing the Nextcloud folder that

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


### Public Sharing

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)