Update user documentation

[zorglubu]

Add paragraphs : Starting with cookbook, Adding a recipe. And move up Using keywords and categories

[MarcelRobitaille]

Thank you for the documentation improvements. Would you please updated your commit message with --amend and add Signed-off-by: Author Name <authoremail@example.com> and force push? Check the details of the failed DCO check.

BTW in the future you can use git commit -s in order to add this to the message automatically.

[zorglubu]

Thank you for the documentation improvements. Would you please updated your commit message with --amend and add Signed-off-by: Author Name <authoremail@example.com> and force push? Check the details of the failed DCO check.

BTW in the future you can use git commit -s in order to add this to the message automatically.

Hello, I am not really familiar with git. I did the modifications directly on the github website.
Do I have to upload the file to my computer and use the command line ? I am really sorry, I just don't know what you mean with the "commit message". Is it my comment "Add paragraphs : ....." ?
Or are you able to copy the text and do the commit, and cancel my request ?
Thank you

[MarcelRobitaille]

I am not aware of any way to do this in the GitHub website, but I can do it from the command line for you. Would you please let me know which name and email address I can use?

[zorglubu]

I am not aware of any way to do this in the GitHub website, but I can do it from the command line for you. Would you please let me know which name and email address I can use?

Thanks for your suggestion for help. But I don't want to put my name and email on a public website. Could you just copy the text and do that with your credentials (of course, if you agree with the modifications) ?

[MarcelRobitaille]

I understand. Unfortunately, it is a requirement of Nextcloud, for legal reasons I believe.

@christianlupus, could you please advise what to do in this situation?

[christianlupus]

Relax. I will fix it. I just need my laptop.

[codecov]

Codecov Report

Merging #936 (a815248) into master (43fc64e) will decrease coverage by 6.08%.
The diff coverage is n/a.

❗ Current head a815248 differs from pull request most recent head 3281ecb. Consider uploading reports for the commit 3281ecb to get more accurate results

@@            Coverage Diff             @@
##           master     #936      +/-   ##
==========================================
- Coverage   28.50%   22.42%   -6.09%     
==========================================
  Files          29       21       -8     
  Lines        1540     1476      -64     
==========================================
- Hits          439      331     -108     
- Misses       1101     1145      +44     

Flag	Coverage Δ
integration	5.75% <ø> (+0.23%)	⬆️
unittests	16.66% <ø> (-6.33%)	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
lib/Service/RecipeService.php	0.00% <0.00%> (ø)
lib/Helper/ImageService/ImageFileHelper.php
lib/Exception/RecipeImageExistsException.php
lib/Service/ThumbnailService.php
lib/Exception/InvalidThumbnailTypeException.php
lib/Service/ImageService.php
lib/Helper/ImageService/ImageGenerationHelper.php
lib/Exception/NoRecipeImageFoundException.php
lib/Helper/ImageService/ThumbnailFileHelper.php

[christianlupus]

The requirement is no big deal here. It should make sure that someone feels responsible for the changes. So, @MarcelRobitaille you could have amended without problem. Git differences the notion of an author (the person who wrote the changes and is the intellectual origin) and the committer (the one who puts things into the repository). For many cases these two are equivalent. By git commit --amend you take the role of the committer not the author (unless you put --reset-author as well).
The DCO only checks if the committer mail matches the Signed-Off of the commit message. Github shows this as well (note the two avatars before the commit name):

I will just make a few minor modifications to the PR to be more precise and prevent the changelog issue.

[github-actions]

Unit Test Results

     22 files       22 suites   8m 1s ⏱️
   120 tests    120 ✔️ 0 💤 0 ❌
1 320 runs  1 320 ✔️ 0 💤 0 ❌

Results for commit 3281ecb.

♻️ This comment has been updated with latest results.

[christianlupus]

May I ask you @zorglubu what the intention of a dedicated image folder would be? From the perspective of the cookbook app it is definitively not required. Contrary, this will store all recipe images twice: Once in the common folder and once per recipe.

I do not want to silently remove your wording. So, I am just curiously asking for your opinion/reason for this suggestion. Feel free to communicate. This might seem a general misunderstanding and thus a good point for documentation 😄

[zorglubu]

That clearly means that I didn't understand something, and that a clear documentation would be a good thing ;-)
Fell free to modify that, and by the way, I will be grateful if you check my english everywhere !

As a new user, I did put the pictures in a separate folder like /photos/recipes, and I just now discovered that they were as well in the recipe's sub-folder. But when we create a new recipe, this sub-folder doesn't exist yet. Then I presume that the process should be :

• to upload this picture somewhere in Nextcloud
• to add it to the recipe
• and finally to delete the first one ?

[christianlupus]

There are different ways.

• One, you have described.
• Use an external URL if you have the image on the web
• There is I think some heuristics in place ATM to look for a file within the NC server files
• There is a plan for adding an image on the fly. We could then enhance the UI to upload an image directly.

[MarcelRobitaille]

Thanks for jumping in @christianlupus. I figured I could put my name, but I didn't want to sign off because I'm not yet familiar enough with the project to know if everything was accurate.

[christianlupus]

Seems a good starting point. LGTM.