diff --git a/docs/docs/assets/stylesheets/custom.css b/docs/docs/assets/stylesheets/custom.css index 45dc642f41a..3651816001b 100644 --- a/docs/docs/assets/stylesheets/custom.css +++ b/docs/docs/assets/stylesheets/custom.css @@ -51,3 +51,7 @@ a[target="_blank"]:not([class*="md-"]):after { th { font-weight: bold; } + +.md-button { + padding: 0.2rem 0.75rem !important; +} diff --git a/docs/docs/changelog/v1.0.0.md b/docs/docs/changelog/v1.0.0.md index e04bc11d0df..7197805dcb1 100644 --- a/docs/docs/changelog/v1.0.0.md +++ b/docs/docs/changelog/v1.0.0.md @@ -1,3 +1,21 @@ +## v1.0.0b - 2022-05-22 + +- Bump Dependencies + - Recipe Scrapers to 13.28 + - Jinja2 to 3.1.2 + - FastAPI to 0.78.0 + +- Recipe Ingredient Editor + - [#1140](https://github.com/hay-kot/mealie/issues/1140) - Error in processing the quantity of ingredients #1140 - UI Now prevents entering not-allowed characters in quantity field + - UI now allows no value to be set in addition to a zero (0) value. + - [#1237](https://github.com/hay-kot/mealie/issues/1237) - UI: Saving a 0 quantity ingredient displays 0 until the page is refreshed #1237 - UI Now properly reacts to changes in the quantity field. + +- Fix Mealie v0.5.x migration issue [#1183](https://github.com/hay-kot/mealie/issues/1183) +- Consolidated Frontend Types thanks to [@PFischbeck](https://github.com/Fischbeck) +- Added support for SSL/No Auth Email [@nkringle](https://github.com/nkringle) +- [Implement several notifications for server actions ](https://github.com/hay-kot/mealie/pull/1234)[@miroito](https://github.com/Miroito) +- Fix display issue for shared recipe rendering on server [@PFischbeck](https://github.com/Fischbeck) + ## v1.0.0b - 2022-05-09 - Change MIT license to AGPLv3 diff --git a/docs/docs/documentation/getting-started/features.md b/docs/docs/documentation/getting-started/features.md index 8e360163e24..5d33b428e60 100644 --- a/docs/docs/documentation/getting-started/features.md +++ b/docs/docs/documentation/getting-started/features.md @@ -1,10 +1,14 @@ +!!! info "Feature Set" + This isn't an exhaustive list of features within Mealie, but it does capture the most important, overarching features that Mealie offers. + + ## Recipes ### Creating Recipes Mealie offers two main ways to create recipes. You can use the integrated recipe-scraper to create recipes from hundreds of websites, or you can create recipes manually using the recipe editor. -[Demo](https://beta.mealie.io/recipe/create?tab=url){ .md-button .md-button--primary } +[Demo](https://beta.mealie.io/recipe/create?tab=url){ .md-button .md-button--primary .align-right } ### Importing Recipes @@ -17,22 +21,24 @@ Mealie supports importing recipes from a few other sources besides websites. Cur You can access these options on your installation at the `/group/migrations` page on your installation. If you'd like to see another source added, feel free to request so on Github. + [Demo](https://beta.mealie.io/group/data/foods){ .md-button .md-button--primary } + ### Organizing Recipes -Mealie has a few ways to organize recipes you create. +Mealie has a robust and flexible recipe organization system with a few different ways to organize your recipes in a way that fits your household. #### Categories -Categories are the overarching organizer for recipes. You can assign as many categories as you'd like to a recipe, but we recommend that you try to limit the categories you assign to a recipe to one or two. This helps keep categories as broad as possible while still allowing you to find recipes that are related to each other. For example, you might assign a recipe to the category `Breakfast`, `Lunch`, `Dinner`, or `Side`. +Categories are the overarching organizer for recipes. You can assign as many categories as you'd like to a recipe, but we recommend that you try to limit the categories you assign to a recipe to one or two. This helps keep categories as focused as possible while still allowing you to find recipes that are related to each other. For example, you might assign a recipe to the category **Breakfast**, **Lunch**, **Dinner**, or **Side**. [Demo](https://beta.mealie.io/recipes/categories){ .md-button .md-button--primary } #### Tags -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. +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. [Demo](https://beta.mealie.io/recipes/tags){ .md-button .md-button--primary } @@ -50,26 +56,82 @@ Mealie also has the concept of cookbooks. These can be created inside of a group #### Examples: -- Main Courses: This cookbooks has all the recipes that have the `Dinner` category -- Pasta Sides: Recipes that have both the `Side` category and the `Pasta` tag -- Dessert Breads: Recipes that have both the `Bread` category and the `Dessert` tag +- Main Courses: This cookbooks has all the recipes that have the **Dinner** category +- Pasta Sides: Recipes that have both the **Side** category and the **Pasta** tag +- Dessert Breads: Recipes that have both the **Bread** category and the **Dessert** tag [Demo](https://beta.mealie.io/group/cookbooks){ .md-button .md-button--primary } ## Meal Planning -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. 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. +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. + +!!! tip + 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. [Demo](https://beta.mealie.io/group/mealplan/planner){ .md-button .md-button--primary } ### Planner Rules -You can create rules for auto selecting recipes for you meal plans. These rules are used by the server to determine the random pool of recipes to select from when creating meal plans. +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.** [Demo](https://beta.mealie.io/group/mealplan/settings){ .md-button .md-button--primary } -## Shopping +## Shopping Lists + +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. + +!!! warning + 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. + + +[Demo](https://beta.mealie.io/shopping-lists){ .md-button .md-button--primary } -## Application Management ## Data Management + +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/` pages: + +- Recipes + - Bulk Actions + - Export + - Tag + - Categorize + - Delete +- Foods + - Import/Seed your database with a collection of over 200 foods! + - Merge Foods into a single food entry + - Export as JSON +- Units + - Import/Seed your database with a collection of the most common units of measurement + - Merge Units into a single unit entry + - Export as JSON + +[Demo](https://beta.mealie.io/group/data/foods){ .md-button .md-button--primary } + +## Server Administration + +### 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. + +[Demo](https://beta.mealie.io/admin/site-settings){ .md-button .md-button--primary } + +### Users and Group + +There is a small management area for users and groups that allows you to create, edit, and delete users and groups. + +[Demo](https://beta.mealie.io/admin/manage/users){ .md-button .md-button--primary } + +### Backups + +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.** + + +[Demo](https://beta.mealie.io/admin/backups){ .md-button .md-button--primary } + + +!!! note + This is **NOT** the same as backups in v0.5.4. We've greatly simplified how backups are managed at the database level and we are now taking a full snapshot of the database and restoring it. If you're looking to export your recipes to move to an alternative service, this is likely not the way you'll want to export that data. You'll likely want to handle that through the group data exports page or through the API itself. + + [Group Data Exports](https://beta.mealie.io/group/data/recipes){ .md-button .md-button--primary } diff --git a/docs/docs/documentation/getting-started/migrating-to-mealie-v1.md b/docs/docs/documentation/getting-started/migrating-to-mealie-v1.md index 675b03a732e..72a6175d0e5 100644 --- a/docs/docs/documentation/getting-started/migrating-to-mealie-v1.md +++ b/docs/docs/documentation/getting-started/migrating-to-mealie-v1.md @@ -13,6 +13,24 @@ The version 1 release of Mealie should be seen as an entirely different applicat - [ ] Meal Plans - [ ] Cookbooks / Pages + +## Migration Considerations + +Before you migrate to v1.0.0-beta-x please consider the following: + +**API Integration Will Break** + +Several of the endpoints in the API have changed. This means that you will need to update your code to use the new endpoints. + +**Meal Plan Notifications Are Not Yet Implemented** + +If you're using the Meal Plan webhook feature it has yet to be implemented in v1. This feature is being significantly improved in v1 and has yet to be fully fleshed out. If you were a heavy user, you may want to wait until v1 to use this feature. + +**Recipes are Now Private** + +This can be a plus or a minus depending on your use case. If you relied on the old implementation that allowed viewing of recipes without logging in, you will loose that access. We are planning on implementing a public facing interface for groups/tenants to allow unauthenticated users to view public recipes. + + ## 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. diff --git a/docs/docs/overrides/api.html b/docs/docs/overrides/api.html index 407b674c451..fcb153ccc87 100644 --- a/docs/docs/overrides/api.html +++ b/docs/docs/overrides/api.html @@ -14,7 +14,7 @@
diff --git a/vetur.config.js b/vetur.config.js deleted file mode 100644 index e59ab1d6034..00000000000 --- a/vetur.config.js +++ /dev/null @@ -1,17 +0,0 @@ -// vetur.config.js -/** @type {import('vls').VeturConfig} */ -module.exports = { - settings: { - "vetur.useWorkspaceDependencies": true, - "vetur.experimental.templateInterpolationService": true, - "vetur.validation.interpolation": false, - }, - projects: [ - { - root: "./frontend", - package: "package.json", - tsconfig: "tsconfig.json", - globalComponents: ["./src/components/**/*.vue"], - }, - ], -};