Skip to content

Commit

Permalink
Merge 014a2d6 into 9199824
Browse files Browse the repository at this point in the history
  • Loading branch information
zorglubu authored Mar 28, 2022
2 parents 9199824 + 014a2d6 commit a815248
Show file tree
Hide file tree
Showing 2 changed files with 41 additions and 21 deletions.
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
## [Unreleased]

### 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
58 changes: 37 additions & 21 deletions docs/user/index.md
Original file line number Diff line number Diff line change
@@ -1,33 +1,27 @@
# Usage Documentation

## Starting with Cookbook

## Importing Recipes
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.

### Importing from a Website
- Recipe's directory: check in the *Parameters* of Cookbook, in the low left corner, in which directory they will be stored on Nextcloud.
- Pictures directory: it's also a good idea to create a directory to gather all Cookbook pictures in one place.

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.
## Adding a recipe

<img src="assets/create_import.png" alt="Recipe-import field" width="200px" />
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 cookbokk app will download and use the image.

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.
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.

## Sharing Recipes

### Sharing with another Nextcloud User

Currently, the only way to share recipes is by sharing the Nextcloud folder that contains all recipes with another Nextcloud user. To this end, the folder first needs to be shared from the Nextcloud Files app. Afterwards it can be set as the recipe directory in the Cookbook app’s `Settings` section

<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?
## Using keywords and categories

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

Expand All @@ -45,3 +39,25 @@ 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

### 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.

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

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

Currently, the only way to share recipes is by sharing the Nextcloud folder that contains all recipes with another Nextcloud user. To this end, the folder first needs to be shared from the Nextcloud Files app. Afterwards it can be set as the recipe directory in the Cookbook app’s `Settings` section

<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.

0 comments on commit a815248

Please sign in to comment.