1
0
Fork 0
mirror of https://github.com/mealie-recipes/mealie.git synced 2025-08-03 12:35:22 +02:00

docs: fix typos (#1665)

* docs: fix typos

* typos: fix typos found by `codespell` across the codebase

* docs: fix `macOS` spelling

* docs: fix `authentification` terminology

"Authentification" is not a thing.

* docs: fix `localhost` typo in example link

* typos: fix in-code typos

These are potentially higher risk, but no other mentions of these typos
show up in the codebase.
This commit is contained in:
Ben Boeckel 2022-09-25 23:17:27 +00:00 committed by GitHub
parent 33dad80eff
commit 2e6b877ba9
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
46 changed files with 66 additions and 66 deletions

View file

@ -8,7 +8,7 @@ Recipes can be imported in bulk from a file containing a list of URLs. This can
```bash
#!/bin/bash
function authentification () {
function authentication () {
auth=$(curl -X 'POST' \
"$3/api/auth/token" \
-H 'accept: application/json' \
@ -38,7 +38,7 @@ password="MyPassword"
mealie_url=http://localhost:9000
token=$(authentification $mail $password $mealie_url)
token=$(authentication $mail $password $mealie_url)
import_from_file $input $token $mealie_url
```
@ -51,7 +51,7 @@ See <a href="https://github.com/Jleagle/mealie-importer" target="_blank">Jleagle
import requests
import re
def authentification(mail, password, mealie_url):
def authentication(mail, password, mealie_url):
headers = {
'accept': 'application/json',
'Content-Type': 'application/x-www-form-urlencoded',
@ -90,7 +90,7 @@ password="MyPassword"
mealie_url="http://localhost:9000"
token = authentification(mail, password, mealie_url)
token = authentication(mail, password, mealie_url)
import_from_file(input_file, token, mealie_url)
```

View file

@ -52,7 +52,7 @@ Each of the above organizers can be filtered in searches, and have their own pag
#### Cookbooks
Mealie also has the concept of cookbooks. These can be created inside of a group and can use a cross section of Categories, Tags, and Tools to filter recipes and view them in one specific page. Cookbooks are a great way to keep a supset of recipes easily accessible to you. You can think of them as a saved search results page. While most examples are simple, you can use as many organizers to filter a cookbook as you'd like.
Mealie also has the concept of cookbooks. These can be created inside of a group and can use a cross section of Categories, Tags, and Tools to filter recipes and view them in one specific page. Cookbooks are a great way to keep a subset of recipes easily accessible to you. You can think of them as a saved search results page. While most examples are simple, you can use as many organizers to filter a cookbook as you'd like.
#### Examples:
@ -113,7 +113,7 @@ Managing a robust collection of recipes inevitable requires a lot of data. Meali
### Site Settings
The site settings page contains general information about your installtion 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.
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.
[Demo](https://demo.mealie.io/admin/site-settings){ .md-button .md-button--primary }

View file

@ -63,7 +63,7 @@ After you've configured your database, and updated the `docker-compose.yaml` fil
$ docker-compose up -d
```
You should see the containers start up without error. You should now be able to access the Mealie frontend at [http://localhost:9925](http://locahost:9925).
You should see the containers start up without error. You should now be able to access the Mealie frontend at [http://localhost:9925](http://localhost:9925).
!!! tip "Default Credentials"
@ -102,8 +102,8 @@ While the docker-compose file should work without modification, some users want
![Docker Diagram](../../../assets/img/docker-diagram.drawio.svg)
In the diagram above there's a few crutial things to note.
In the diagram above there's a few crucial things to note.
1. Port 9925 is the host port, this can be anything you want. The important part is that it's mapped to the mealie-frontend container at port 3000.
2. The mealie-frontend container communicated with the mealie-api container through the INTERNAL docker network. This requires that the two containers are on the same network and that the network supports name resolution (anything but the default bridge network). The resolution URL can be specified in the docker-compose as the `API_URL` environment variable.
3. The mealie-data volume is mounted to BOTH the mealie-frontend and mealie-api containers. This is REQUIRED to ensure that images and assets are severed up correctly. While the default configuration is a docker-volume, that same can be accomplished by using a local directory mounted to the containers.
3. The mealie-data volume is mounted to BOTH the mealie-frontend and mealie-api containers. This is REQUIRED to ensure that images and assets are served up correctly. While the default configuration is a docker-volume, that same can be accomplished by using a local directory mounted to the containers.

View file

@ -33,7 +33,7 @@ This can be a plus or a minus depending on your use case. If you relied on the o
## Step 1: Setting Up The New Application
Given the nature of the upgrade, it is highly recommended that you standup a new instance of mealie along side your current instance. This will allow you to migrate your data safely and quickly without any issues. Follow the instructions in the [Installation Checklist](../getting-started/installation/installation-checklist.md) to get started. Once that's complete and you can login, continue here with step 2.
Given the nature of the upgrade, it is highly recommended that you stand up a new instance of mealie along side your current instance. This will allow you to migrate your data safely and quickly without any issues. Follow the instructions in the [Installation Checklist](../getting-started/installation/installation-checklist.md) to get started. Once that's complete and you can login, continue here with step 2.
## Step 2: Exporting Your Data from Pre-v1
@ -42,7 +42,7 @@ In your instance of Mealie prior to v1, perform an export of your data in the Ad
## Step 3: Using the Migration Tool
In your new v1 instance, navigate to `/group/migrations` and select "Mealie" from the dropdown selector. Upload the exported data from your pre-v1 instance. Optionally, you can tag all the recipes you've imported with the `mealie_alpha` tag to help you identify them. Once the upload has finished, submit the form and your migration will begin. This may take some time, but when it's complete you'll be provided a new entry in hte "Previous Migrations" table below. Be sure to review the migration report to make sure everything was successful. There may be instances where some of the recipes were not imported, but the migration will still import all the successful recipes.
In your new v1 instance, navigate to `/group/migrations` and select "Mealie" from the dropdown selector. Upload the exported data from your pre-v1 instance. Optionally, you can tag all the recipes you've imported with the `mealie_alpha` tag to help you identify them. Once the upload has finished, submit the form and your migration will begin. This may take some time, but when it's complete you'll be provided a new entry in the "Previous Migrations" table below. Be sure to review the migration report to make sure everything was successful. There may be instances where some of the recipes were not imported, but the migration will still import all the successful recipes.
In most cases, it's faster to manually migrate the recipes that didn't take instead of trying to identify why the recipes failed to import. If you're experiencing issues with the migration tool, please open an issue on GitHub.

View file

@ -1,6 +1,6 @@
# Backups and Restoring
Mealie provides an integrated mechanics for doing full installation backups of the database. Naviate to `/admin/backups` to
Mealie provides an integrated mechanics for doing full installation backups of the database. Navigate to `/admin/backups` to
- See a list of available backups
- Perform a backups