From ae82d7b1ced7b1c818c26b32112ca0fc2ce403cb Mon Sep 17 00:00:00 2001 From: zorglubu <31647352+zorglubu@users.noreply.github.com> Date: Sun, 27 Mar 2022 10:26:46 +0200 Subject: [PATCH 1/3] Update user documentation Add paragraphs : Starting with cookbook, Adding a recipe. And move up Using keywords and categories Signed-off-by: Christian Wolf --- docs/user/index.md | 54 ++++++++++++++++++++++++++++------------------ 1 file changed, 33 insertions(+), 21 deletions(-) diff --git a/docs/user/index.md b/docs/user/index.md index 5bf2c54c1..a05ca967a 100644 --- a/docs/user/index.md +++ b/docs/user/index.md @@ -1,33 +1,23 @@ # 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 -Recipe-import field +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 : the image must be previously stored on your Nextcloud instance. Click on the icon on the right of the image field, and select 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 *Description*, *Tools*, *Ingredients* or *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 - -Recipe-import field - - -### 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. @@ -45,3 +35,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. + +Recipe-import 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 + +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 + +Recipe-import field + +### Public Sharing + +At the moment it is not possible to share a public link to a recipe. From 402c0c9e3e14bdacb458084b99f4234a8eb160ed Mon Sep 17 00:00:00 2001 From: Christian Wolf Date: Mon, 28 Mar 2022 13:05:04 +0200 Subject: [PATCH 2/3] Corrected some minor issues with the documentation Signed-off-by: Christian Wolf --- docs/user/index.md | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-) diff --git a/docs/user/index.md b/docs/user/index.md index a05ca967a..ac0f4d306 100644 --- a/docs/user/index.md +++ b/docs/user/index.md @@ -2,18 +2,22 @@ ## 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. +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. -- 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. +- 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. ## 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. +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 : the image must be previously stored on your Nextcloud instance. Click on the icon on the right of the image field, and select the image. +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. -Links may be added to other recipes in *Description*, *Tools*, *Ingredients* or *Instructions* : +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. From 014a2d67539233378d719a6ddc9ae36e1cea5104 Mon Sep 17 00:00:00 2001 From: Christian Wolf Date: Mon, 28 Mar 2022 13:13:12 +0200 Subject: [PATCH 3/3] Update the changelog Signed-off-by: Christian Wolf --- CHANGELOG.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index a4bcef723..94d959b45 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -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