Skip to content

Commit c5f2df5

Browse files
authored
fix: Copyedit getting started docs (#2840)
* Correct grammar and typo * Correct grammar * Fix some words * Correct formatting * Correct grammar on v1 migration page * Correct grammar, punctuation, and typos in faq * Fix grammar in installation-checklist * One last correction
1 parent 0703701 commit c5f2df5

File tree

5 files changed

+42
-42
lines changed

5 files changed

+42
-42
lines changed

docs/docs/documentation/getting-started/faq.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## How do I enable "smart" ingredient handling?
44

5-
You might have noticed that scaling up a recipe or making a shopping list doesn't by default handle the ingredients in a way you might expect. Depending on your settings, scaling up might yield things like `2 1 cup broth` instead of `2 cup broth`. And making shopping lists from reciepes that have shared ingredients can yield multiple lines of the same ingredient. **But** mealie has a mechanism to intelligently handle ingredients and make your day better. How?
5+
You might have noticed that scaling up a recipe or making a shopping list doesn't by default handle the ingredients in a way you might expect. Depending on your settings, scaling up might yield things like `2 1 cup broth` instead of `2 cup broth`. And making shopping lists from reciepes that have shared ingredients can yield multiple lines of the same ingredient. **But**, mealie has a mechanism to intelligently handle ingredients and make your day better. How?
66
### Set up your Foods and Units
77
Do the following just **once**. Doing this applies to your whole group, so be careful.
88

@@ -26,9 +26,9 @@ Do the following for each recipe you want to intelligently handle ingredients.
2626
6. Click the Edit button/icon again
2727
7. Scroll to the ingredients and you should see new fields for Amount, Unit, Food, and Note. The Note in particular will contain the original text of the Recipe.
2828
8. Click `Parse` and you will be taken to the ingredient parsing page.
29-
9. Choose your parser. the `Natural Language Parser` works very well, but you can also use the `Brute Parser`.
30-
10. Click `Parse All` and your ingredients should be separated out into Units and Foods based on your seeding in Step 1 above.
31-
11. For ingredients where the Unit or Food were not found, you can click a button to accept an automatically suggested Food to add to the database. Or manually enter the Unit/Food and hit `Enter` (or click `Create`) to add it to the database
29+
9. Choose your parser. The `Natural Language Parser` works very well, but you can also use the `Brute Parser`.
30+
10. Click `Parse All`, and your ingredients should be separated out into Units and Foods based on your seeding in Step 1 above.
31+
11. For ingredients where the Unit or Food was not found, you can click a button to accept an automatically suggested Food to add to the database. Or, manually enter the Unit/Food and hit `Enter` (or click `Create`) to add it to the database
3232
12. When done, click `Save All` and you will be taken back to the recipe. Now the Unit and Food fields of the recipe should be filled out.
3333

3434
Scaling up this recipe or adding it to a Shopping List will now smartly take care of ingredient amounts and duplicate combinations.
@@ -64,7 +64,7 @@ No. Due to limitations from the Javascript Framework, mealie doesn't support ser
6464

6565
## Can I install Mealie without docker?
6666

67-
Yes, you can install Mealie on your local machine. HOWEVER, it is recommended that you don't. Managing non-system versions of python, node, and npm is a pain. Moreover updating and upgrading your system with this configuration is unsupported and will likely require manual interventions. If you insist on installing Mealie on your local machine, you can use the links below to help guide your path.
67+
Yes, you can install Mealie on your local machine. HOWEVER, it is recommended that you don't. Managing non-system versions of python, node, and npm is a pain. Moreover, updating and upgrading your system with this configuration is unsupported and will likely require manual interventions. If you insist on installing Mealie on your local machine, you can use the links below to help guide your path.
6868

6969
- [Advanced Installation](../installation/advanced/)
7070

@@ -75,25 +75,25 @@ Mealie can use fuzzy search, which is robust to minor typos. For example, search
7575
2. Set up a [Postgres](./installation/postgres.md) instance of Mealie
7676
3. Upload the backup .zip and click to apply it (as as migration)
7777

78-
## How i can attach an image or video to a Recipe?
78+
## How can I attach an image or video to a Recipe?
7979

80-
Yes. Mealie's Recipe Steps and other fields support the markdown syntax and therefor supports images and videos. To attach an image to the recipe, you can upload it as an asset and use the provided copy button to generate the html image tag required to render the image. For videos, Mealie provides no way to host videos. You'll need to host your videos with another provider and embed them in your recipe. Generally, the video provider will provide a link to the video and the html tag required to render the video. For example, youtube provides the following link that works inside a step. You can adjust the width and height attributes as necessary to ensure a fit.
80+
Mealie's Recipe Steps and other fields support markdown syntax and therefore support images and videos. To attach an image to the recipe, you can upload it as an asset and use the provided copy button to generate the html image tag required to render the image. For videos, Mealie provides no way to host videos. You'll need to host your videos with another provider and embed them in your recipe. Generally, the video provider will provide a link to the video and the html tag required to render the video. For example, YouTube provides the following link that works inside a step. You can adjust the width and height attributes as necessary to ensure a fit.
8181

8282
```html
8383
<iframe width="560" height="315" src="https://www.youtube.com/embed/nAUwKeO93bY" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
8484
```
8585

8686
## How can I unlock my account?
8787

88-
If your account has been locked by bad password attempts, you can use an administrator account to unlock another account. Alternatively you can unlock all account via a scripts within the container.
88+
If your account has been locked by bad password attempts, you can use an administrator account to unlock another account. Alternatively, you can unlock all accounts via a script within the container.
8989

9090
```shell
9191
docker exec -it mealie-next bash
9292

9393
python /app/mealie/scripts/reset_locked_users.py
9494
```
9595

96-
## How can I change my password
96+
## How can I change my password?
9797

9898
You can change your password by going to the user profile page and clicking the "Change Password" button. Alternatively you can use the following script to change your password via the CLI if you are locked out of your account.
9999

@@ -107,8 +107,8 @@ python /app/mealie/scripts/change_password.py
107107

108108
Managing private groups and recipes can be confusing. The following diagram and notes should help explain how they work to determine if a recipe can be shared publicly.
109109

110-
- Private links that are generated using th`Share` button bypass all group and recipe permissions.
111-
- Private groups block all access to recipes, including those that are public. Expect as noted above.
110+
- Private links that are generated using the `Share` button bypass all group and recipe permissions.
111+
- Private groups block all access to recipes, including those that are public, except as noted above.
112112
- Private recipes block all access to the recipe from public links. This does not affect Private Links.
113113

114114
```mermaid
@@ -133,7 +133,7 @@ stateDiagram-v2
133133
```
134134

135135
## Can I use fail2ban with mealie?
136-
Yes, mealie is configured to properly forward external IP addresses into the `mealie.log` logfile. Note that, due to restrictions in docker, IP address forwarding only works on linux.
136+
Yes, mealie is configured to properly forward external IP addresses into the `mealie.log` logfile. Note that due to restrictions in docker, IP address forwarding only works on Linux.
137137

138138
Your fail2ban usage should look like the following:
139139
```
@@ -142,12 +142,12 @@ Use failregex line : ^ERROR:\s+Incorrect username or password from <HOST>
142142
```
143143

144144
## Why An API?
145-
An API allows integration into applications like [Home Assistant](https://www.home-assistant.io/) that can act as notification engines to provide custom notifications based of Meal Plan data to remind you to defrost the chicken, marinade the steak, or start the CrockPot. Additionally, you can access nearly any backend service via the API giving you total control to extend the application. To explore the API spin up your server and navigate to http://yourserver.com/docs for interactive API documentation.
145+
An API allows integration into applications like [Home Assistant](https://www.home-assistant.io/) that can act as notification engines to provide custom notifications based on Meal Plan data to remind you to defrost the chicken, marinade the steak, or start the CrockPot. Additionally, you can access nearly any backend service via the API giving you total control to extend the application. To explore the API spin up your server and navigate to http://yourserver.com/docs for interactive API documentation.
146146

147147
## Why a Database?
148-
Some users of static-site generator applications like ChowDown have expressed concerns about their data being stuck in a database. Considering this is a new project it is a valid concern to be worried about your data. Mealie specifically addresses this concern by provided automatic daily backups that export your data in json, plain-text markdown files, and/or custom Jinja2 templates. **This puts you in controls of how your data is represented** when exported from Mealie, which means you can easily migrate to any other service provided Mealie doesn't work for you.
148+
Some users of static-site generator applications like ChowDown have expressed concerns about their data being stuck in a database. Considering this is a new project, it is a valid concern to be worried about your data. Mealie specifically addresses this concern by provided automatic daily backups that export your data in json, plain-text markdown files, and/or custom Jinja2 templates. **This puts you in control of how your data is represented** when exported from Mealie, which means you can easily migrate to any other service provided Mealie doesn't work for you.
149149

150150
As to why we need a database?
151151

152-
- **Developer Experience:** Without a database a lot of the work to maintain your data is taken on by the developer instead of a battle tested platform for storing data.
153-
- **Multi User Support:** With a solid database as backend storage for your data Mealie can better support multi-user sites and avoid read/write access errors when multiple actions are taken at the same time.
152+
- **Developer Experience:** Without a database, a lot of the work to maintain your data is taken on by the developer instead of a battle-tested platform for storing data.
153+
- **Multi User Support:** With a solid database as backend storage for your data, Mealie can better support multi-user sites and avoid read/write access errors when multiple actions are taken at the same time.

docs/docs/documentation/getting-started/features.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -38,15 +38,15 @@ Categories are the overarching organizer for recipes. You can assign as many cat
3838

3939
#### Tags
4040

41-
Tags, are nearly identical to categories in function but play a secondary role in some cases. As such, we recommend that you use tags freely to help you organize your recipes by more specific topics. For example, if a recipe can be frozen or is a great left-over meal, you could assign the tags **frozen** and **left-over** and easily filter for those at a later time.
41+
Tags are nearly identical to categories in function but play a secondary role in some cases. As such, we recommend that you use tags freely to help you organize your recipes by more specific topics. For example, if a recipe can be frozen or is a great left-over meal, you could assign the tags **frozen** and **left-over** and easily filter for those at a later time.
4242

4343
[Tags Demo](https://demo.mealie.io/g/home/recipes/tags){ .md-button .md-button--primary }
4444

4545
#### Tools
4646

47-
Tools, are another way that some users like to organize their recipes. If a recipe requires some specific equipment if can be helpful to assign the tools to the recipes. This is particularly useful for things that are less common, like a pressure cooker, or a sous vide.
47+
Tools are another way that some users like to organize their recipes. If a recipe requires some specific equipment, it can be helpful to assign tools to the recipes. This is particularly useful for things that are less common, like a pressure cooker or a sous vide.
4848

49-
Each of the above organizers can be filtered in searches, and have their own pages where you can view all the recipes that are associated with those organizers.
49+
Each of the above organizers can be filtered in searches and have their own pages where you can view all the recipes that are associated with those organizers.
5050

5151
[Tools Demo](https://demo.mealie.io/g/home/recipes/tools){ .md-button .md-button--primary }
5252

@@ -64,7 +64,7 @@ Mealie also has the concept of cookbooks. These can be created inside of a group
6464

6565
## Meal Planning
6666

67-
Mealie uses a calendar like view to help you plan your meals. It shows you the previous day, and the next 6 days by default. You can toggle through the calendar by clicking the arrows on the top of the page. In editor mode, you can use the random recipe buttons, or manually add an entry.
67+
Mealie uses a calendar like view to help you plan your meals. It shows you the previous day and the next 6 days by default. You can toggle through the calendar by clicking the arrows on the top of the page. In editor mode, you can use the random recipe buttons or manually add an entry.
6868

6969
!!! tip
7070
You can also add a "Note" type entry to your meal-plan when you want to include something that might not have a specific recipes. This is great for leftovers, or for ordering out.
@@ -73,24 +73,24 @@ Mealie uses a calendar like view to help you plan your meals. It shows you the p
7373

7474
### Planner Rules
7575

76-
The meal planner has the concept of plan rules. These offer a flexible way to use your organizers to customize how a random recipe is inserted into your meal plan. You can set rules to restrict the pool of recipes based on the Tags and/or Categories of a recipe. Additionally, since meal plans have a Breakfast, Lunch, Dinner, and Snack labels you can specifically set a rule to be active for a **specific meal type** or even a **specific day of the week.**
76+
The meal planner has the concept of plan rules. These offer a flexible way to use your organizers to customize how a random recipe is inserted into your meal plan. You can set rules to restrict the pool of recipes based on the Tags and/or Categories of a recipe. Additionally, since meal plans have a Breakfast, Lunch, Dinner, and Snack labels, you can specifically set a rule to be active for a **specific meal type** or even a **specific day of the week.**
7777

7878
[Planner Settings Demo](https://demo.mealie.io/group/mealplan/settings){ .md-button .md-button--primary }
7979

8080
## Shopping Lists
8181

82-
The shopping lists feature is a great way to keep track of what you need to buy for your next meal. You can add items directly to the shopping list, or link a recipe and all of it's ingredients to track meals during the week.
82+
The shopping lists feature is a great way to keep track of what you need to buy for your next meal. You can add items directly to the shopping list or link a recipe and all of it's ingredients to track meals during the week.
8383

8484
!!! warning
85-
At this time there isn't a tight integration between meal-plans and shopping lists, however it's something we have planned for the future.
85+
At this time there isn't a tight integration between meal-plans and shopping lists; however, it's something we have planned for the future.
8686

8787

8888
[Shopping List Demo](https://demo.mealie.io/shopping-lists){ .md-button .md-button--primary }
8989

9090

9191
## Data Management
9292

93-
Managing a robust collection of recipes inevitable requires a lot of data. Mealie has a robust data management system that allows you to easily some of the more important data sets in your collection. Here's some of the features that are available in the `group/data/<type>` pages:
93+
Managing a robust collection of recipes inevitable requires a lot of data. Mealie has a robust data management system that allows you to easily export some of the more important data sets in your collection. Here's some of the features that are available in the `group/data/<type>` pages:
9494

9595
- Recipes
9696
- Bulk Actions
@@ -113,7 +113,7 @@ Managing a robust collection of recipes inevitable requires a lot of data. Meali
113113

114114
### Site Settings
115115

116-
The site settings page contains general information about your installation like the application version, some configuration details, and some utilities to help you confirm your installation is working as expected. For example, you can use the Email Configuration section to validate that your email credentials are setup correctly and that the email service is working as expected. Additionally, there is a docker-volume utility that will confirm your volumes are configured and shared correctly between the front and backend of the application.
116+
The site settings page contains general information about your installation like the application version, some configuration details, and some utilities to help you confirm your installation is working as expected. For example, you can use the Email Configuration section to validate that your email credentials are set up correctly and that the email service is working as expected. Additionally, there is a docker-volume utility that will confirm your volumes are configured and shared correctly between the front and backend of the application.
117117

118118
[Settings Demo](https://demo.mealie.io/admin/site-settings){ .md-button .md-button--primary }
119119

@@ -125,7 +125,7 @@ There is a small management area for users and groups that allows you to create,
125125

126126
### Backups
127127

128-
The backups page provides a full system backup of your installation including all assets and images related to recipes. These are archived into a zip file and stored on the server but can also be downloaded through the UI. Due to some issues in the past Mealie no longer performs automatic backups, **it is advised that during setup you also setup a backup strategy to ensure your data is not lost.**
128+
The backups page provides a full system backup of your installation including all assets and images related to recipes. These are archived into a zip file and stored on the server but can also be downloaded through the UI. Due to some issues in the past, Mealie no longer performs automatic backups; **it is advised that during setup you also set up a backup strategy to ensure your data is not lost.**
129129

130130

131131
[Backups Demo](https://demo.mealie.io/admin/backups){ .md-button .md-button--primary }

0 commit comments

Comments
 (0)