From 5d8210d57085da2ad24aebd7b4a040b5bb812506 Mon Sep 17 00:00:00 2001 From: boc-the-git <3479092+boc-the-git@users.noreply.github.com> Date: Mon, 24 Jun 2024 01:34:17 +1000 Subject: [PATCH] docs: Add database changes, remove changelogs (#3778) --- docs/docs/changelog/v0.1.0.md | 88 -------------- docs/docs/changelog/v0.2.0.md | 72 ----------- docs/docs/changelog/v0.3.0.md | 29 ----- docs/docs/changelog/v0.4.0.md | 86 -------------- docs/docs/changelog/v0.4.1.md | 35 ------ docs/docs/changelog/v0.4.2.md | 34 ------ docs/docs/changelog/v0.4.3.md | 14 --- docs/docs/changelog/v0.5.0.md | 129 -------------------- docs/docs/changelog/v0.5.1.md | 11 -- docs/docs/changelog/v0.5.2.md | 65 ---------- docs/docs/changelog/v1.0.0.md | 178 ---------------------------- docs/docs/changelog/v1.0.0beta-2.md | 29 ----- docs/docs/changelog/v1.0.0beta-3.md | 36 ------ docs/docs/changelog/v1.0.0beta-4.md | 126 -------------------- docs/docs/changelog/v1.0.0beta-5.md | 3 - docs/mkdocs.yml | 18 +-- 16 files changed, 1 insertion(+), 952 deletions(-) delete mode 100644 docs/docs/changelog/v0.1.0.md delete mode 100644 docs/docs/changelog/v0.2.0.md delete mode 100644 docs/docs/changelog/v0.3.0.md delete mode 100644 docs/docs/changelog/v0.4.0.md delete mode 100644 docs/docs/changelog/v0.4.1.md delete mode 100644 docs/docs/changelog/v0.4.2.md delete mode 100644 docs/docs/changelog/v0.4.3.md delete mode 100644 docs/docs/changelog/v0.5.0.md delete mode 100644 docs/docs/changelog/v0.5.1.md delete mode 100644 docs/docs/changelog/v0.5.2.md delete mode 100644 docs/docs/changelog/v1.0.0.md delete mode 100644 docs/docs/changelog/v1.0.0beta-2.md delete mode 100644 docs/docs/changelog/v1.0.0beta-3.md delete mode 100644 docs/docs/changelog/v1.0.0beta-4.md delete mode 100644 docs/docs/changelog/v1.0.0beta-5.md diff --git a/docs/docs/changelog/v0.1.0.md b/docs/docs/changelog/v0.1.0.md deleted file mode 100644 index 73ead4f2b65..00000000000 --- a/docs/docs/changelog/v0.1.0.md +++ /dev/null @@ -1,88 +0,0 @@ -# v0.1.0 - Initial Beta - -### Bug Fixes - - Fixed Can't delete recipe after changing name - Closes Closes #67 - - Fixed No image when added by URL, and can't add an image - Closes Closes #66 - - Fixed Images saved with no way to delete when add recipe via URL fails - Closes Closes #43 - -### Features - - Additional Language Support - - Improved deployment documentation - - Additional database! SQlite is now supported! - Closes #48 - - All site data is now backed up. - - Support for Prep Time, Total Time, and Cook Time field - Closes #63 - - New backup import process with support for themes and site settings - - **BETA** ARM support! - Closes #69 - -### Code / Developer Improvements - - Unified Database Access Layers - - Poetry / pyproject.toml support over requirements.txt - - Local development without database is now possible! - - Local mkdocs server added to docker-compose.dev.yml - - Major code refactoring to support new database layer - - Global variable refactor - -### Breaking Changes - -- Internal docker port is now 80 instead of 9000. You MUST remap the internal port to connect to the UI. - -!!! error "Breaking Changes" - As I've adopted the SQL database model I find that using 2 different types of databases will inevitably hinder development. As such after release v0.1.0 support for mongoDB will no longer be available. Prior to upgrading to v0.2.0 you will need to export your site and import after updating. This should be a painless process and require minimal intervention on the users part. Moving forward we will do our best to minimize changes that require user intervention like this and make updates a smooth process. - - -## v0.0.2 - Pre-release Second Patch -A quality update with major props to [zackbcom](https://github.com/zackbcom) for working hard on making the theming just that much better! - -### Bug Fixes - - Fixed empty backup failure without markdown template - - Fixed opacity issues with marked steps - [mtoohey31](https://github.com/mtoohey31) - - Fixed hot-reloading development environment - [grssmnn](https://github.com/grssmnn) - - Fixed recipe not saving without image - Closes #7 + Closes #54 - - Fixed parsing error on image property null - Closes #43 - -### General Improvements - - Added Confirmation component to deleting recipes - [zackbcom](https://github.com/zackbcom) - - Updated Theme backend - [zackbcom](https://github.com/zackbcom) - - Added Persistent storage to vuex - [zackbcom](https://github.com/zackbcom) - - General Color/Theme Improvements - - More consistent UI - - More minimalist coloring - - Added API key extras to Recipe Data - [See Documentation](/api/api-usage/) - - Users can now add custom json key/value pairs to all recipes via the editor for access in 3rd part applications. For example users can add a "message" field in the extras that can be accessed on API calls to play a message over google home. - - Improved image rendering (nearly x2 speed) - - Improved documentation + API Documentation - - Improved recipe parsing - Closes #51 - - User feedback on backup importing - -## v0.0.1 - Pre-release Patch -### General - - Updated Favicon - - Renamed Frontend Window - - Added Debug folder to dump scraper data prior to processing. - -### Recipes - - Added user feedback on bad URL - - Better backend data validation for updating recipes, avoid small syntax errors corrupting database entry. [Closes #8](https://github.com/mealie-recipes/mealie/issues/8) - - Fixed spacing Closes while editing new recipes in JSON - -## v0.0.0 - Initial Pre-release -The initial pre-release. It should be semi-functional but does not include a lot of user feedback You may notice errors that have no user feedback and have no idea what went wrong. - -### Recipes - - Automatic web scrapping for common recipe platforms - - Interactive API Documentation thanks to [FastAPI](https://fastapi.tiangolo.com/) and [Swagger](https://petstore.swagger.io/) - - UI Recipe Editor - - JSON Recipe Editor in browser - - Custom tags and categories - - Rate recipes - - Add notes to recipes - - Migration From Other Platforms - - Chowdown -### Meal Planner - - Random Meal plan generation based off categories - - Expose notes in the API to allow external applications to access relevant information for meal plans - -### Database Import / Export - - Easily Import / Export your recipes from the UI - - Export recipes in markdown format for universal access - - Use the default or a custom jinja2 template \ No newline at end of file diff --git a/docs/docs/changelog/v0.2.0.md b/docs/docs/changelog/v0.2.0.md deleted file mode 100644 index 4b29a916563..00000000000 --- a/docs/docs/changelog/v0.2.0.md +++ /dev/null @@ -1,72 +0,0 @@ -# v0.2.1 - Hot Fixes! - -### Features and Improvements - - Fixes upload image error when no photo was scrapped - - Fixes no last_recipe.json not updating - - Added markdown rendering for notes - - New notifications - - Minor UI improvements - - Recipe editor refactor - - Settings/Theme models refactor - -### Development / Misc - - Added async file response for images, downloading files. - - Breakup recipe view component - -# v0.2.0 - Now with Test! -This is, what I think, is a big release! Tons of new features and some great quality of life improvements with some additional features. You may find that I made promises to include some fixes/features in v0.2.0. The short of is I greatly underestimated the work needed to refactor the database to a usable state and integrate categories in a way that is useful for users. This shouldn't be taken as a sign that I'm dropping those feature requests or ignoring them. I felt it was better to push a release in the current state rather than drag on development to try and fulfil all of the promises I made. - -!!! warning "Upgrade Process" - Database Breaks! I have not yet implemented a database migration service. As such, upgrades cannot be done by simply pulling the image. You must first export your recipes, update your deployment, and then import your recipes. This pattern is likely to be how upgrades take place prior to v1.0. After v1.0 migrations will be done automatically. - -### Bug Fixes - - Remove ability to save recipe with no name - - Fixed data validation error on missing parameters - - Fixed failed database initialization at startup - Closes #98 - - Fixed misaligned text on various cards - - Fixed bug that blocked opening links in new tabs - Closes #122 - - Fixed router link bugs - Closes #122 - - Fixed navigation on keyboard selection - Closes #139 - -### Features and Improvements - - 🐳 Dockerfile now 1/5 of the size! - - 🌎 UI Language Selection + Additional Supported Language - - **Home Page** - - By default your homepage will display only the recently added recipes. You can configured sections to show on the home-screen based of categories on the settings page. - - A new sidebar is now shown on the main page that lists all the categories in the database. Clicking on them navigates into a page that shows only recipes. - - Basic Sort functionality has been added. More options are on the way! - - **Meal Planner** - - Improved Search (Fuzzy Search) - - New Scheduled card support - - **Recipe Editor** - - Ingredients are now sortable via drag-and-drop - - Known categories now show up in the dropdown - Closes 83 - - Initial code for data validation to prevent errors - - **Migrations** - - Card based redesign - - Upload from the UI - - Unified Chowdown / Nextcloud import process. (Removed Git as a dependency) - - **API** - - Category and Tag endpoints added - - Major Endpoint refactor - - Improved API documentation - - Link to your Local API is now on your `/settings/site`. You can use it to explore your API. - - - **Style** - - Continued work on button/style unification - - Adding icons to buttons - - New Color Theme Picker UI - -### Development - - Fixed Vetur config file. Autocomplete in VSCode works! - - File/Folder restructuring - - Added Prettier config - - Fixed incorrect layout code - - FastAPI Route tests for major operations - WIP (shallow testing) - -### Breaking Changes - -!!! error "Breaking Changes" - - API endpoints have been refactored to adhere to a more consistent standard. This is a WIP and more changes are likely to occur. - - Officially Dropped MongoDB Support - - Database Breaks! We have not yet implemented a database migration service. As such, upgrades cannot be done by simply pulling the image. You must first export your recipes, update your deployment, and then import your recipes. This pattern is likely to be how upgrades take place prior to v1.0. After v1.0 migrations will be done automatically. diff --git a/docs/docs/changelog/v0.3.0.md b/docs/docs/changelog/v0.3.0.md deleted file mode 100644 index 755ff2f32df..00000000000 --- a/docs/docs/changelog/v0.3.0.md +++ /dev/null @@ -1,29 +0,0 @@ -# v0.3.0 - -### Bug Fixes - - Fixed open search on `/` when in input. - Closes #174 - - Error when importing recipe: KeyError: '@type' - Closes #145 - - Fixed Import Issue - bhg.com - Closes #138 - - Scraper not working with recipe containing HowToSection - Closes #73 - -### Features and Improvements - - Improved Nextcloud Imports - - Improved Recipe Parser! - - Open search with `/` hotkey! - - Database and App version are now split - - Unified and improved snackbar notifications - - New Category/Tag endpoints to filter all recipes by Category or Tag - - Category sidebar now has show/hide behavior on mobile - - Settings menu on mobile is improved - - **Meal Planner** - - You can now restrict recipe categories used for random meal-plan creation in the settings menu - - Recipe picker dialog will now display recipes when the search bar is empty - - Minor UI improvements - - **Shopping lists!** Shopping list can now be generated from a meal plan. Currently ingredients are split by recipes or there is a beta feature that attempts to sort them by similarity. - - **Recipe Viewer** - - Categories, Tags, and Notes will now be displayed below the steps on smaller screens - - **Recipe Editor** - - Text areas now auto grow to fit content - - Description, Steps, and Notes support Markdown! This includes inline html in Markdown. - - **Imports** - - A revamped dialog has been created to provide more information on restoring backups. Exceptions on the backend are now sent to the frontend and are easily viewable to see what went wrong when you restored a backup. This functionality will be ported over to the migrations in a future release. diff --git a/docs/docs/changelog/v0.4.0.md b/docs/docs/changelog/v0.4.0.md deleted file mode 100644 index 94d7aa15b49..00000000000 --- a/docs/docs/changelog/v0.4.0.md +++ /dev/null @@ -1,86 +0,0 @@ -# v0.4.0 Whoa, What a Release! - -**App Version: v0.4.0** - -**Database Version: v0.4.0** - -## Breaking Changes - -!!! error "Breaking Changes" - - #### Database - A new database will be created. You must export your data and then import it after upgrading. - - #### Site Settings - With the addition of group settings and a re-write of the database layer of the application backend, there is no migration path for your current site settings. Webhooks Settings, Meal Plan Categories are now managed by groups. Site settings, mainly homepage settings, are now site specific and managed by administrators. When upgrading be sure to uncheck the settings when importing your old data. - - #### ENV Variables - Names have been changed to be more consistent with industry standards. See the [Installation Page](/mealie/getting-started/install/) for new parameters. - -## Bug Fixes -- Fixed Search Results Limited to 100 - #198 -- Fixed recipes from marmiton.org not fully scrapped - #196 -- Fixed Unable to get a page to load - #194 -- Fixed Recipe's from Epicurious don't upload. - #193 -- Fixed Edited blank recipe in meal plan is not saved - #184 -- Fixed Create a new meal plan allows selection of an end date that is prior to the start date - #183 -- Fixed Original URL not saved to imported recipe in 0.3.0-dev - #183 -- Fixed "IndexError: list index out of range" when viewing shopping list for meal plan containing days without a recipe selected - #178 - -## Features and Improvements - -### General - - Documentation Rewrite - - [New Demo Site!](https://mealie-demo.hay-kot.dev/) - - New Documentation - - Landing Page - - Custom Caddy Configuration - - User Management - - Introduction - - Updated Documentation - - Everything! - - The API Reference is now better embedded inside of the docs - - New default external port in documentation (Port 9000 -> 9925). This is only the port exposed by the host to the docker image. It doesn't change any existing functionality. - -### User Authentication - - Authentication! Tons of stuff went into creating a flexible authentication platform for a lot of different use cases. Review the documentation for more information on how to use the authentication, and how everything works together. More complex management of recipes and user restrictions are in the works, but this is a great start! Some key features include - - Sign Up Links - - Admin and User Roles - - Password Change - - Group Management - - Create/Edit/Delete Restrictions - -### Custom Pages - - You can now create custom pages that are displayed on the homepage sidebar to organize categories of recipes into pages. For example, if you have several categories that encompass "EntrΓ©e" you can group all those categories together under the "EntrΓ©e" page. See [Building Pages](/mealie/site-administration/building-pages/) for more information. -!!! tip - Note that this replaces the behavior of automatically adding categories to the sidebar. - -### UI Improvements - - Completed Redesign of the Admin Panel - - Profile Pages - - Side Panel Menu - - Improved UI for Recipe Search - - Language selector is now displayed on all pages and does not require an account - -### Recipe Data - - Recipe Database Refactoring. Tons of new information is now stored for recipes in the database. Not all is accessible via the UI, but it's coming. - - Nutrition Information - - calories - - fatContent - - fiberContent - - proteinContent - - sodiumContent - - sugarContent - - recipeCuisine has been added - - "categories" has been migrated to "recipeCategory" to adhere closer to the standard schema - - "tool" - a list of tools used for the recipe - -### Behind the Scenes - - Removed CDN dependencies - - Database Model Refactoring - - Import/Export refactoring - - File/Folder Name Refactoring - - Development is now easier with a makefile - - Mealie is now a proper package using poetry - - Test refactoring - - Test Coverage 83% up from 75%! diff --git a/docs/docs/changelog/v0.4.1.md b/docs/docs/changelog/v0.4.1.md deleted file mode 100644 index 9ab671f6afc..00000000000 --- a/docs/docs/changelog/v0.4.1.md +++ /dev/null @@ -1,35 +0,0 @@ -# v0.4.1 - -**App Version: v0.4.1** - -**Database Version: v0.4.0** - -!!! error "Breaking Changes" - - #### Recipe Images - While it *shouldn't* be a breaking change, I feel it is important to note that you may experience issues with the new image migration. Recipe images are now minified, this is done on start-up, import, migration, and when a new recipe is created. The initial boot or load may be a bit slow if you have lots of recipes but you likely won't notice. What you may notice is that if your recipe slug and the image name do not match, you will encounter issues with your images showing up. This can be resolved by finding the image directory and rename it to the appropriate slug. I did fix multiple edge cases, but it is likely more exists. As always make a backup before you update! - - On the plus side, this comes with a huge performance increase! πŸŽ‰ - -- Add markdown support for ingredients - Resolves #32 -- Ingredients editor improvements -- Fix Tags/Categories render problems on recipes -- Tags redirect to new tag pages -- Categories redirect to category pages -- Fix Backup download blocked by authentication -- Random meal-planner will no longer duplicate recipes unless no other options -- New Quick Week button to generate next 5 day week of recipe slots. -- Minor UI tweaks -- Recipe Cards now display 2 recipe tags -- Recipe images are now minified. This comes with a serious performance improvement. On initial startup you may experience some delays. Images are migrated to the new structure on startup, depending on the size of your database this can take some time. - - Note that original images are still kept for large displays like on the individual recipe pages. - - A smaller image is used for recipe cards - - A 'tiny' image is used for search images. -- Advanced Search Page. You can now use the search page to filter recipes to include/exclude tags and categories as well as select And/Or matching criteria. -- Added link to advanced search on quick search -- Better support for NextCloud imports - - Translate keywords to tags - - Fix rollback on failure -- Recipe Tag/Category Input components have been unified and now share a single way to interact. To add a new category in the recipe editor you need to click to '+' icon next to the input and fill out the form. This is the same for adding a Tag. - - diff --git a/docs/docs/changelog/v0.4.2.md b/docs/docs/changelog/v0.4.2.md deleted file mode 100644 index f69d9e03424..00000000000 --- a/docs/docs/changelog/v0.4.2.md +++ /dev/null @@ -1,34 +0,0 @@ -# v0.4.2 - -**App Version: v0.4.2** - -**Database Version: v0.4.0** - -!!! error "Breaking Changes" - 1. With a recent refactor some users been experiencing issues with an environmental variable not being set correct. If you are experiencing issues, please provide your comments [Here](https://github.com/mealie-recipes/mealie/issues/281). - - 2. If you are a developer, you may experience issues with development as a new environmental variable has been introduced. Setting `PRODUCTION=false` will allow you to develop as normal. - -## Bug Fixes -- Fixed Initialization script (v0.4.1a Hot Fix) - Closes #274 -- Fixed nested list error on recipe scrape - Closes #306 -- Fixed ingredient checkboxes - Closes #304 -- Removed link on recent - Closes #297 -- Categories sidebar is auto generated if no pages are created - Closes #291 -- Fix tag issues on creating custom pages - Closes #290 -- Validate paths on export - Closes #275 -- Walk Nextcloud import directory - Closes #254 - -## General Improvements -- Improved Nextcloud Migration. Mealie will now walk the directories in a zip file looking for directories that match the pattern of a Nextcloud Recipe. Closes #254 - - Rewrite Keywords to Tag Fields - - Rewrite url to orgURL -- Improved Chowdown Migration -- Migration report is now similar to the Backup report -- Tags/Categories are now title cased on import "dinner" -> "Dinner" -- Depreciate `ENV` variable to `PRODUCTION` -- Set `PRODUCTION` env variable to default to true -- Unify Logger across the backend -- mealie.log and last_recipe.json are now downloadable from the frontend from the /admin/about -- New download schema where you request a token and then use that token to hit a single endpoint to download a file. This is a notable change if you are using the API to download backups. -- Recipe images can now be added directly from a URL - [See #117 for details](https://github.com/mealie-recipes/mealie/issues/117) \ No newline at end of file diff --git a/docs/docs/changelog/v0.4.3.md b/docs/docs/changelog/v0.4.3.md deleted file mode 100644 index 0893c8c8162..00000000000 --- a/docs/docs/changelog/v0.4.3.md +++ /dev/null @@ -1,14 +0,0 @@ -# v0.4.3 - -**App Version: v0.4.3** - -**Database Version: v0.4.0** - -## Bug Fixes -- Fix Upload error for Migrations -- Fixes #315 - Cannot select another language -- Fixes #314 - case-sensitive emails -- Fixes #312 - Profile Image Reload - -## Improvements -- New TOKEN_TIME and DEFAULT_EMAIL env variables \ No newline at end of file diff --git a/docs/docs/changelog/v0.5.0.md b/docs/docs/changelog/v0.5.0.md deleted file mode 100644 index 5ff3e4a3bc2..00000000000 --- a/docs/docs/changelog/v0.5.0.md +++ /dev/null @@ -1,129 +0,0 @@ -# v0.5.0 Too Many Changes! - -**App Version: v0.5.0** - -**Database Version: v0.5.0** - -## Breaking Changes - -!!! error "Breaking Changes" - - #### Database - Database version has been bumped from v0.4.x -> v0.5.0. You will need to export and import your data. Moving forward, we will be using database migrations (BETA) to do this automatically. Note that you still must backup your data. If you don't, it's entirely possible something may go wrong and you could lose your data on upgrade. - - #### Image Directory - the /data/img directory has been depreciated. All images are now stored in the /recipes/{slug}/image directory. Images should be migrated automatically, but you may experience issues related to this change. - - #### API Usage - If you have been using the API directly, many of the routes and status codes have changed. You may experience issues with directly consuming the API. - - #### Arm/v7 Support - Mealie will no longer build in CI/CD due to a issue with the rust compiler on 32 bit devices. You can reference [this issue on the matrix-org/synapse](https://github.com/matrix-org/synapse/issues/9403) Github page that are facing a similar issue. You may still be able to build the docker image you-self. - -!!! warning "Potential Data Loss" - With this release comes a major rework of how files are stored on disk and where things belong. Migration of files should be done automatically. We have tested extensively with many different backups and user bases and have found that no one experienced data-loss. HOWEVER, with all the major changes that have occurred, it is vital that to prevent any data-loss you must create a backup and store that backup outside of your mealie instance. If you do not do this, you may lose your data. - -## Bug Fixes -- Fixed #25 - Allow changing rating without going into edit -- Fixed #475 - trim whitespace on login -- Fixes #435 - Better Email Regex -- Fixed #428 - Meal Planner now works on iOS devices -- Fixed #419 - Typos -- Fixed #418 - You can now "export" shopping lists -- Fixed #356 - Shopping List items are now grouped -- Fixed #329 - Fixed profile image not loading -- Fixed #461 - Proper JSON serialization on webhooks -- Fixed #332 - Language settings are saved for one browser -- Fixes #281 - Slow Handling of Large Sets of Recipes -- Fixed #356 - Shopping lists generate duplicate items -- Fixed #271 - Slow handling of larger data sets -- Fixed #472, #469, #458, #456 - Improve Recipe Parser - -## Features and Improvements - -### Highlights -- Recipe Parser - - Recipes can now be imported with a bookmarklet! - - Significant improvement in supported sites with the new [Recipe Scraper Library](https://github.com/hhursev/recipe-scrapers) - - UI Debugging now available at `/recipes/debugger` - - Better error messages on failure - - ⚠️ last_recipe.json is now depreciated -- Beta Support for Postgres! πŸŽ‰ See the getting started page for details -- Recipe Features - - New button bar for editors with improved accessibility and performance - - Step Sections now supported - - Recipe Assets - - Add Asset image to recipe step - - Additional View Settings. - - Better print support -- New Toolbox Page! - - Bulk assign categories and tags by keyword search - - Title case all Categories or Tags with 1 click - - Create/Rename/Delete Operations for Tags/Categories - - Remove Unused Categories or Tags with 1 click -- Recipe Cards now have a menu button for quick actions! - - Edit - - Delete - - Integrated Share with supported OS/Browsers - - Print -- New Profile Dashboard! - - Edit Your Profile - - Create/Edit Themes - - View other users in your Group - - See what's for dinner - - Manage Long Live API Tokens (New) -- New Admin Dashboard! πŸŽ‰ - - Now you can get some insight on your application with application statistics and events. - - See uncategorized/untagged recipes and organize them! - - Backup/Restore right from your dashboard - - See server side events. Now you can know who deleted your favorite recipe! -- New Event Notifications through the Apprise Library - - Get notified when specific server side events occur - -### Meal Planner -- Multiple Recipes per day -- Supports meals without recipes (Enter title and description) -- Generate share-link from created meal-planners -- Shopping lists can be directly generated from the meal plan - -### General -- User can now favorite recipes -- New 'Dark' Color Theme Packaged with Mealie -- Updated Recipe Card Sections Toolbar - - New Sort Options (They work this time!) - - Alphabetical - - Rating - - Created Date - - Updated Date - - Shuffle (Random Sort) - - New 'Random' Recipe button on recipe sections. Random recipes are selected from the filtered results below. For example, on the "Cakes" category page, you will only get recipes in the "Cakes" category. -- Rating can be updated without entering the editor - Closes #25 -- Updated recipe editor styles and moved notes to below the steps. -- Redesigned search bar -- 'Dinner this week' shows a warning when no meal is planned yet -- 'Dinner today' shows a warning when no meal is planned yet -- More localization -- Start date for Week is now selectable -- Languages are now managed through Crowdin -- Application Bar was Rewritten - - Sidebar can now be toggled everywhere. - - New and improved mobile friendly bottom bar - - Improved styling for search bar in desktop - - Improved search layout on mobile -- Profile image now shown on all sidebars -- Switched from Flash Messages to Snackbar (Removed dependency) - -### Performance -- Images are now served up by the Caddy increase performance and offloading some loads from the API server -- Requesting all recipes from the server has been rewritten to refresh less often and manage client side data better. -- All images are now converted to .webp for better compression - -### Behind the Scenes -- The database layer has been added for future recipe scaling. -- Black and Flake8 now run as CI/CD checks -- New debian based docker image -- Unified Sidebar Components -- Refactor UI components to fit Vue best practices (WIP) -- The API returns more consistent status codes -- The API returns error code instead of error text when appropriate - - ⚠️ May cause side-effects if you were directly consuming the API \ No newline at end of file diff --git a/docs/docs/changelog/v0.5.1.md b/docs/docs/changelog/v0.5.1.md deleted file mode 100644 index ad54dface04..00000000000 --- a/docs/docs/changelog/v0.5.1.md +++ /dev/null @@ -1,11 +0,0 @@ -# v0.5.1 - -**App Version: v0.5.1** - -**Database Version: v0.5.0** - - -## Bug Fixes -- Fixed #538 - Missing Ingredients on Editor -- Fixed error on webhooks for new groups -- Fixed various icons references \ No newline at end of file diff --git a/docs/docs/changelog/v0.5.2.md b/docs/docs/changelog/v0.5.2.md deleted file mode 100644 index 4542df0d3d0..00000000000 --- a/docs/docs/changelog/v0.5.2.md +++ /dev/null @@ -1,65 +0,0 @@ -# v0.5.2 - DRAFT - -**App Version: v0.5.2** - -**Database Version: v0.5.0** - -## Bug Fixes -- Fixed #617 - Section behavior when adding a step -- Fixed #615 - Recipe Settings are not available when creating new recipe -- Fixed #625 - API of today's image returns strange characters -- Fixed [#590](https://github.com/mealie-recipes/mealie/issues/590) - Duplicate Events when using Gunicorn Workers - -## Features and Improvements - -### General -- Recipe Instructions now collapse when checked -- Default recipe settings can be set through ENV variables -- Recipe Ingredient lists can now container ingredient sections. -- You can now download and upload individual recipes - - -### Localization - -Huge thanks to [@sephrat](https://github.com/sephrat) for all his work on the project. He's very consistent in his contributions to the project and nearly every release has had some of his code in it! Here's some highlights from this release - - - Lazy Load Translations (Huge Performance Increase!) - - Tons of localization additions all around the site. - - All of the work that goes into managing and making Crowdin a great feature the application - -#### Here a list of contributors on Crowding who make Mealie possible in different locals - -| Name | Languages | Translated (Words) | Target Words | -| ---------------------------- | ------------------ | :----------------: | :----------: | -| retmas-gh | Polish | 550 | 625 | -| startos | Italian | 310 | 322 | -| CMBoii | Spanish | 256 | 291 | -| sephrat | French | 255 | 296 | -| Daniel Tildeman (tildeman) | Swedish | 233 | 228 | -| Rourke | Dutch | 216 | 214 | -| Andreas Waschinski (Wascha) | German | 207 | 202 | -| wengtad | Chinese Simplified | 176 | 343 | -| Matthias Borremans (MrBorri) | Dutch | 96 | 89 | -| Adam Syndoman (pypckompsite) | Polish | 68 | 65 | -| JonasSchubert | German | 22 | 23 | -| ThrawnJL | Danish | 7 | 7 | -| NicholasBrody | Dutch | 7 | 7 | -| Giel Janssens (gieljnssns) | Dutch | 4 | 4 | -| kentora | Danish | 3 | 2 | - - - -### Docker - -#### Huge thanks to [@wengtad](https://github.com/wengtad) for all his work on improving the deployment with docker. - - - Optimize Docker Dev Size (Frontend: from ~1.52GB to ~429MB | API: from ~657MB to ~380MB) - - Optimize Docker Prod Size (from ~542MB to ~373MB) - - Add Gunicorn - - Add Gunicorn and Webworkers to Dockerfile #550 - - Add Docs for Gunicorn - - Add PUID/PGID to Docker. Fixes Initialization scripts fail to run when not executing as root user inside container #350, - - Not able to run correctly in docker if user permissions are specified #429 - - Merge Dockerfile.dev into Dockerfile (dev shared same base together with prod) - - Add Docs for PUID/PGID - - Add Docker healthcheck (for this is not necessary, I could remove if you want) \ No newline at end of file diff --git a/docs/docs/changelog/v1.0.0.md b/docs/docs/changelog/v1.0.0.md deleted file mode 100644 index bdac6eb4849..00000000000 --- a/docs/docs/changelog/v1.0.0.md +++ /dev/null @@ -1,178 +0,0 @@ -## 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/mealie-recipes/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/mealie-recipes/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/mealie-recipes/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/mealie-recipes/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 - -## v1.0.0b - 2022-05-08 - -- Rewrote the registration flow for new users. -- Added support for seed data at anytime through the user interface. -- Improved security for sanitizing HTML inputs for user input. -- Added support for importing keywords as tags during scraping - [@miroito](https://github.com/Miroito) -- Changed default recipe settings to "disable_amount=True" for new groups. -- Add support for merging food, and units. -- Allow tags, category, and tool creation - [@miroito](https://github.com/Miroito) -- Added additional and more comprehensive filter options for cookbooks -- Fixed bookmarklets error - -## v1.0.0b - 2022-03-29 - -- Mealie now stores the original text from parsed ingredients, with the ability to peak at the original text from a recipe. [@miroito](https://github.com/Miroito) -- Added some management / utility functions for administrators to manage data and cleanup artifacts from the file system. -- Fix clear url action in recipe creation [#1101](https://github.com/mealie-recipes/mealie/pull/1101) [@miroito](https://github.com/Miroito) -- Add group statistics calculations and data storage measurements - - No hard limits are currently imposed on groups - though this may be implemented in the future. - -## v1.0.0b - 2022-03-25 - -- Mealie now packages the last git commit as the build ID -- Admin section now has a "Maintenance" page where you can check some health metrics like data directory size, logs file size, and if there are some non compliant directories or images. You can also perform clean-up operations to resolve some of these issues. -- Dropped 2 dependencies and moved to using our own base model within the project -- Removed lots of dead backup code -- Recipe names will now be auto-incremented when a conflict is found. So if you're adding a recipe named "Tomato Soup" and that recipe name already exists in your database one will be created with the name "Tomato Soup (1)". Currently this is done in a loop until a suitable name is found, however it will error out after 10 attempts so it's best to find a more descriptive name for your recipe. -- Fixed broken PWA where it wouldn't render any content -- Added database connection retry loop to ensure that the database is available prior to starting -- Reorganized group routes to be more consistent with the rest of the application - -## v1.0.0b Beta Release! - -!!! error "Breaking Changes" - As you may have guessed, this release comes with some breaking changes. If you are/were consuming the API you will need to validate all endpoints as nearly all of them have changed. - - To import your data into Mealie v1 from the most recent previous release, you'll need to export and import your data using the built in method. **Note that only your recipes will be usable in the migration**. - -### ✨ What's New (What isn't?!?!) - -#### πŸ₯³ General - -- Mealie will by default only be accessible to users. Future plans are to create spaces for non-users to access a specific group. -- Mealie has gone through a big redesign and has tried to standardize it's look a feel a bit more across the board. -- User/Group settings are now completely separated from the Administration page. -- All settings and configurations pages now have some sort of self-documenting help text. Additional text or descriptions are welcome from PRs -- New experimental banner for the site to give users a sense of what features are still "in development" and provide a link to a github issue that provides additional context. -- Groups now offer full multi-tenant support so you can all groups have their own set of data. - -##### βš™οΈ Site Settings Page - -- Site Settings has been completely revamped. All site-wide settings at defined on the server as ENV variables. The site settings page now only shows you the non-secret values for reference. It also has some helpers to let you know if something isn't configured correctly. - - Server Side Bare URL will let you know if the BASE_URL env variable has been set - - Secure Site let's you know if you're serving via HTTPS or accessing by localhost. Accessing without a secure site will render some of the features unusable. - - Email Configuration Status will let you know if all the email settings have been provided and offer a way to send test emails. - -#### πŸ‘¨β€πŸ‘©β€πŸ‘§β€πŸ‘¦ Users and Groups - -- All members of a group can generate invitation tokens for other users to join their group -- Users now a have "Advanced" setting to enable/disable features like Webhooks and API tokens. This will also apply to future features that are deemed as advanced. -- "Pages" have been dropped in favor of Cookbooks which are now group specific so each group can have it's own set of cookbooks -- Default recipe settings can now be set by the group instead of environmental variables. -- Password reset via email -- Invitation to group by email -- Manage group member permissions - -#### πŸ“¦ Data Migrations - -- Migrations have been moved from the Admin Page to a Group Migration page. Migrations from applications (or previous versions of Mealie) can now be imported into Mealie via the Group Migration pages where all recipes will be imported into the group. -- **Supported Migrations** - - Mealie Pre v1.0.0 - - Nextcloud Recipes - - Chowdown - -#### πŸ›’ Shopping Lists - -- Shopping Lists has been completely revamped to be more flexible and user friendly. - - Add recipe ingredients to a shopping list - - Manually add item/ingredient to shopping list - - Copy as markdown or plain text - - Sort by food/item Labels - - Checked items are now hidden - - Uncheck all Items - - Delete all checked items - -#### πŸ“’ Apprise Integration - -- Server based Apprise notifications have been deprecated. An effort has been made to improve logging overall in the application and make it easier to monitor/debug through the logs. -- The Apprise integration has been updated to the latest version and is now used asynchronously. -- Notifiers now support a wider variety of events. -- Notifiers can now be managed by-group instead of by the server. - -#### πŸ—“ Meal Plans - -- Meal plans have been completely redesigned to use a calendar approach so you'll be able to see what meals you have planned in a more traditional view -- Drag and Drop meals between days -- Add Recipes or Notes to a specific day -- New context menu action for recipes to add a recipe to a specific day on the meal-plan -- New rule based meal plan generator/selector. You can now create rules to restrict the addition of recipes for specific days or meal types (breakfast, lunch, dinner, side). You can also create rules that match against "all" days or "all" meal types to create global rules based around tags and categories. This gives you the most flexibility in creating meal plans. - -#### πŸ₯™ Recipes - -##### πŸ” Search - -- Search now includes the ability to fuzzy search ingredients -- Search now includes an additional filter for "Foods" which will filter (Include/Exclude) matches based on your selection. - -##### 🍴 Recipe General - -- Recipe Pages now implement a screen lock on supported devices to keep the screen from going to sleep. -- Recipes are now only viewable by group members -- Recipes can be shared with share links -- Shared recipes can now render previews for the recipe on sites like Twitter, Facebook, and Discord. -- Recipes now have a `tools` attribute that contains a list of required tools/equipment for the recipe. Tools can be set with a state to determine if you have that tool or not. If it's marked as on hand it will show checked by default. -- Recipe Extras now only show when advanced mode is toggled on -- You can now import multiple URLs at a time pre-tagged using the bulk importer. This task runs in the background so no need to wait for it to finish. -- Foods/Units for Ingredients are now supported (toggle inside your recipe settings) -- Common Food and Units come pre-packaged with Mealie -- Landscape and Portrait views are now available -- Users with the advanced flag turned on will now be able to manage recipe data in bulk and perform the following actions: - - Set Categories - - Set Tags - - Delete Recipes - - Export Recipes -- Recipes now have a `/cook` page for a simple view of the recipe where you can click through each step of a recipe and it's associated ingredients. -- The Bulk Importer has received many additional upgrades. - - Trim Whitespace: automatically removes leading and trailing whitespace - - Trim Prefix: Removes the first character of each line. Useful for when you paste in a list of ingredients or instructions that have 1. or 2. in front of them. - - Split By Numbered Line: Attempts to split a paragraph into multiple lines based on the patterns matching '1.', '1:' or '1)'. - -##### 🍞 Recipe Ingredients - -- Recipe ingredients can now be scaled when the food/unit is defined -- Recipe ingredients can now be copied as markdown lists - - example `- [ ] 1 cup of flour` -- You can now use Natural Language Processing (NLP) to process ingredients and attempt to parse them into amounts, units, and foods. There is an additional "Brute Force" processor that can be used as pattern matching parser to try and determine ingredients. **Note** if you are processing a Non-English language you will have terrible results with the NLP and will likely need to use the Bruce Force processor. - -##### πŸ“œ Recipe Instructions - -- Can now be merged with the above step automatically through the action menu -- Recipe Ingredients can be linked directly to recipe instructions for improved display - - There is an option in the linking dialog to automatically link ingredients. This works by using a key-word matching algorithm to find the ingredients. It's not perfect so you'll need to verify the links after use, additionally you will find that it doesn't work for non-english languages. -- Recipe Instructions now have a preview tab to show the rendered markdown before saving. - -#### ⚠️ Other things to know... - -- Themes have been deprecated for specific users. You can still set specific themes for your site through ENV variables. This approach should yield much better results for performance and some weirdness users have experienced. -- If you've experienced slowness in the past, you may notice a significant improvement in the "All Recipes" and "Search" pages, or wherever large payloads of recipes are being displayed. This is due to not validating responses from the database, as such if you are consuming these API's you may get extra values that are unexpected. - -#### πŸ‘¨β€πŸ’» Backend/Development Goodies - -- Codebase is significantly more organized both Frontend and Backend -- We've moved to Nuxt for SSR and Typescript for better type safety and less bugs πŸŽ‰ -- Backend now using a Class based architecture to maximize code reuse -- Tons of performance improvements across the board -- Significant work was done by [@PFischbeck](https://github.com/PFischbeck) to improve type safety on the frontend server and fix many type related errors/bugs! diff --git a/docs/docs/changelog/v1.0.0beta-2.md b/docs/docs/changelog/v1.0.0beta-2.md deleted file mode 100644 index 944fe06d42b..00000000000 --- a/docs/docs/changelog/v1.0.0beta-2.md +++ /dev/null @@ -1,29 +0,0 @@ -### Bug Fixes - -- Bump isomorphic-dompurify from 0.18.0 to 0.19.0 in /frontend ([#1257](https://github.com/mealie-recipes/mealie/issues/1257)) -- Bump @nuxtjs/auth-next in /frontend ([#1265](https://github.com/mealie-recipes/mealie/issues/1265)) -- Bad dev dependency ([#1281](https://github.com/mealie-recipes/mealie/issues/1281)) -- Add touch support for mealplanner delete ([#1298](https://github.com/mealie-recipes/mealie/issues/1298)) - -### Documentation - -- Add references for VSCode dev containers ([#1299](https://github.com/mealie-recipes/mealie/issues/1299)) -- Docker-compose.dev.yml is currently not functional ([#1300](https://github.com/mealie-recipes/mealie/issues/1300)) - -### Features - -- Add reports to bulk recipe import (url) ([#1294](https://github.com/mealie-recipes/mealie/issues/1294)) -- Rewrite print implementation to support new ing ([#1305](https://github.com/mealie-recipes/mealie/issues/1305)) - -### Miscellaneous Tasks - -- Github stalebot changes ([#1271](https://github.com/mealie-recipes/mealie/issues/1271)) -- Bump eslint-plugin-nuxt in /frontend ([#1258](https://github.com/mealie-recipes/mealie/issues/1258)) -- Bump @vue/runtime-dom in /frontend ([#1259](https://github.com/mealie-recipes/mealie/issues/1259)) -- Bump nuxt-vite from 0.1.3 to 0.3.5 in /frontend ([#1260](https://github.com/mealie-recipes/mealie/issues/1260)) -- Bump vue2-script-setup-transform in /frontend ([#1263](https://github.com/mealie-recipes/mealie/issues/1263)) -- Update dev dependencies ([#1282](https://github.com/mealie-recipes/mealie/issues/1282)) - -### Refactor - -- Split up recipe create page ([#1283](https://github.com/mealie-recipes/mealie/issues/1283)) diff --git a/docs/docs/changelog/v1.0.0beta-3.md b/docs/docs/changelog/v1.0.0beta-3.md deleted file mode 100644 index 4bde91b7f76..00000000000 --- a/docs/docs/changelog/v1.0.0beta-3.md +++ /dev/null @@ -1,36 +0,0 @@ -### Bug Fixes - -- Update issue links in v1.0.0beta-2 changelog ([#1312](https://github.com/mealie-recipes/mealie/issues/1312)) -- Bad import path ([#1313](https://github.com/mealie-recipes/mealie/issues/1313)) -- Printer page refs ([#1314](https://github.com/mealie-recipes/mealie/issues/1314)) -- Consolidate stores to fix mismatched state -- Bump @vue/composition-api from 1.6.1 to 1.6.2 in /frontend ([#1275](https://github.com/mealie-recipes/mealie/issues/1275)) -- Shopping list label editor ([#1333](https://github.com/mealie-recipes/mealie/issues/1333)) - -### Features - -- Default unit fractions to True -- Add unit abbreviation support ([#1332](https://github.com/mealie-recipes/mealie/issues/1332)) -- Attached images by drag and drop for recipe steps ([#1341](https://github.com/mealie-recipes/mealie/issues/1341)) - -### Docs - -- Render homepage social media link images at 32x32 size ([#1310](https://github.com/mealie-recipes/mealie/issues/1310)) - -### Miscellaneous Tasks - -- Init git-cliff config -- Bump @types/sortablejs in /frontend ([#1287](https://github.com/mealie-recipes/mealie/issues/1287)) -- Bump @babel/eslint-parser in /frontend ([#1290](https://github.com/mealie-recipes/mealie/issues/1290)) - -### Refactor - -- Unify recipe-organizer components ([#1340](https://github.com/mealie-recipes/mealie/issues/1340)) - -### Security - -- Delay server response whenever username is non existing ([#1338](https://github.com/mealie-recipes/mealie/issues/1338)) - -### Wip - -- Pagination-repository ([#1316](https://github.com/mealie-recipes/mealie/issues/1316)) diff --git a/docs/docs/changelog/v1.0.0beta-4.md b/docs/docs/changelog/v1.0.0beta-4.md deleted file mode 100644 index aa8f12669fd..00000000000 --- a/docs/docs/changelog/v1.0.0beta-4.md +++ /dev/null @@ -1,126 +0,0 @@ -### Security - -#### v1.0.0beta-3 and Under - Recipe Scraper: Server Side Request Forgery Lead To Denial Of Service - -!!! error "CWE-918: Server-Side Request Forgery (SSRF)" - In this case if a attacker try to load a huge file then server will try to load the file and eventually server use its all memory which will dos the server - -##### Mitigation - -HTML is now scraped via a Stream and canceled after a 15 second timeout to prevent arbitrary data from being loaded into the server. - -#### v1.0.0beta-3 and Under - Recipe Assets: Remote Code Execution - -!!! error "CWE-1336: Improper Neutralization of Special Elements Used in a Template Engine" - As a low privileged user, Create a new recipe and click on the "+" to add a New Asset. - Select a file, then proxy the request that will create the asset. - - Since mealie/routes/recipe/recipe_crud_routes.py:306 is calling slugify on the name POST parameter, we use $ which slugify() will remove completely. - - Since mealie/routes/recipe/recipe_crud_routes.py:306 is concatenating raw user input from the extension POST parameter into the variable file_name, which ultimately gets used when writing to disk, we can use a directory traversal attack in the extension (e.g. ./../../../tmp/pwn.txt) to write the file to arbitrary location on the server. - - As an attacker, now that we have a strong attack primitive, we can start getting creative to get RCE. Since the files were being created by root, we could add an entry to /etc/passwd, create a crontab, etc. but since there was templating functionality in the application that peaked my interest. The PoC in the HTTP request above creates a Jinja2 template at /app/data/template/pwn.html. Since Jinja2 templates execute Python code when rendered, all we have to do now to get code execution is render the malicious template. This was easy enough. - -##### Mitigation - -We've added proper path sanitization to ensure that the user is not allowed to write to arbitrary locations on the server. - -!!! warning "Breaking Change Incoming" - As this has shown a significant area of exposure in the templates that Mealie was provided for exporting recipes, we'll be removing this feature in the next Beta release and will instead rely on the community to provide tooling around transforming recipes using templates. This will significantly limit the possible exposure of users injecting malicious templates into the application. The template functionality will be completely removed in the next beta release v1.0.0beta-5 - -#### All version Markdown Editor: Cross Site Scripting - -!!! error "CWE-79: Cross-site Scripting (XSS) - Stored" - A low privilege user can insert malicious JavaScript code into the Recipe Instructions which will execute in another person's browser that visits the recipe. - - `` - -##### Mitigation - -This issues is present on all pages that allow markdown input. This error has been mitigated by wrapping the 3rd Party Markdown component and using the `domPurify` library to strip out the dangerous HTML. - -#### v1.0.0beta-3 and Under - Image Scraper: Server-Side Request Forgery - -!!! error "CWE-918: Server-Side Request Forgery (SSRF)" - In the recipe edit page, is possible to upload an image directly or via an URL provided by the user. The function that handles the fetching and saving of the image via the URL doesn't have any URL verification, which allows to fetch internal services. - - Furthermore, after the resource is fetch, there is no MIME type validation, which would ensure that the resource is indeed an image. After this, because there is no extension in the provided URL, the application will fallback to jpg, and original for the image name. - - Then the result is saved to disk with the original.jpg name, that can be retrieved from the following URL: http:///api/media/recipes//images/original.jpg. This file will contain the full response of the provided URL. - - **Impact** - - An attacker can get sensitive information of any internal-only services running. For example, if the application is hosted on Amazon Web Services (AWS) platform, its possible to fetch the AWS API endpoint, https://169.254.169.254, which returns API keys and other sensitive metadata. - -##### Mitigation - -Two actions were taken to reduce exposure to SSRF in this case. - -1. The application will not prevent requests being made to local resources by checking for localhost or 127.0.0.1 domain names. -2. The mime-type of the response is now checked prior to writing to disk. - -If either of the above actions prevent the user from uploading images, the application will alert the user of what error occurred. - -### Bug Fixes - -- For erroneously-translated datetime config ([#1362](https://github.com/mealie-recipes/mealie/issues/1362)) -- Fixed text color on RecipeCard in RecipePrintView and implemented ingredient sections ([#1351](https://github.com/mealie-recipes/mealie/issues/1351)) -- Ingredient sections lost after parsing ([#1368](https://github.com/mealie-recipes/mealie/issues/1368)) -- Increased float rounding precision for CRF parser ([#1369](https://github.com/mealie-recipes/mealie/issues/1369)) -- Infinite scroll bug on all recipes page ([#1393](https://github.com/mealie-recipes/mealie/issues/1393)) -- Fast fail of bulk importer ([#1394](https://github.com/mealie-recipes/mealie/issues/1394)) -- Bump @mdi/js from 5.9.55 to 6.7.96 in /frontend ([#1279](https://github.com/mealie-recipes/mealie/issues/1279)) -- Bump @nuxtjs/i18n from 7.0.3 to 7.2.2 in /frontend ([#1288](https://github.com/mealie-recipes/mealie/issues/1288)) -- Bump date-fns from 2.23.0 to 2.28.0 in /frontend ([#1293](https://github.com/mealie-recipes/mealie/issues/1293)) -- Bump fuse.js from 6.5.3 to 6.6.2 in /frontend ([#1325](https://github.com/mealie-recipes/mealie/issues/1325)) -- Bump core-js from 3.17.2 to 3.23.1 in /frontend ([#1383](https://github.com/mealie-recipes/mealie/issues/1383)) -- All-recipes page now sorts alphabetically ([#1405](https://github.com/mealie-recipes/mealie/issues/1405)) -- Sort recent recipes by created_at instead of date_added ([#1417](https://github.com/mealie-recipes/mealie/issues/1417)) -- Only show scaler when ingredients amounts enabled ([#1426](https://github.com/mealie-recipes/mealie/issues/1426)) -- Add missing types for API token deletion ([#1428](https://github.com/mealie-recipes/mealie/issues/1428)) -- Entry nutrition checker ([#1448](https://github.com/mealie-recipes/mealie/issues/1448)) -- Use == operator instead of is_ for sql queries ([#1453](https://github.com/mealie-recipes/mealie/issues/1453)) -- Use `mtime` instead of `ctime` for backup dates ([#1461](https://github.com/mealie-recipes/mealie/issues/1461)) -- Mealplan pagination ([#1464](https://github.com/mealie-recipes/mealie/issues/1464)) -- Properly use pagination for group event notifies ([#1512](https://github.com/mealie-recipes/mealie/pull/1512)) - -### Documentation - -- Add go bulk import example ([#1388](https://github.com/mealie-recipes/mealie/issues/1388)) -- Fix old link -- Pagination and filtering, and fixed a few broken links ([#1488](https://github.com/mealie-recipes/mealie/issues/1488)) - -### Features - -- Toggle display of ingredient references in recipe instructions ([#1268](https://github.com/mealie-recipes/mealie/issues/1268)) -- Add custom scaling option ([#1345](https://github.com/mealie-recipes/mealie/issues/1345)) -- Implemented "order by" API parameters for recipe, food, and unit queries ([#1356](https://github.com/mealie-recipes/mealie/issues/1356)) -- Implement user favorites page ([#1376](https://github.com/mealie-recipes/mealie/issues/1376)) -- Extend Apprise JSON notification functionality with programmatic data ([#1355](https://github.com/mealie-recipes/mealie/issues/1355)) -- Mealplan-webhooks ([#1403](https://github.com/mealie-recipes/mealie/issues/1403)) -- Added "last-modified" header to supported record types ([#1379](https://github.com/mealie-recipes/mealie/issues/1379)) -- Re-write get all routes to use pagination ([#1424](https://github.com/mealie-recipes/mealie/issues/1424)) -- Advanced filtering API ([#1468](https://github.com/mealie-recipes/mealie/issues/1468)) -- Restore frontend sorting for all recipes ([#1497](https://github.com/mealie-recipes/mealie/issues/1497)) -- Implemented local storage for sorting and dynamic sort icons on the new recipe sort card ([1506](https://github.com/mealie-recipes/mealie/pull/1506)) -- create new foods and units from their Data Management pages ([#1511](https://github.com/mealie-recipes/mealie/pull/1511)) - -### Miscellaneous Tasks - -- Bump dev deps ([#1418](https://github.com/mealie-recipes/mealie/issues/1418)) -- Bump @vue/runtime-dom in /frontend ([#1423](https://github.com/mealie-recipes/mealie/issues/1423)) -- Backend page_all route cleanup ([#1483](https://github.com/mealie-recipes/mealie/issues/1483)) - -### Refactor - -- Remove depreciated repo call ([#1370](https://github.com/mealie-recipes/mealie/issues/1370)) - -### Hotfix - -- Tame typescript beast - -### UI - -- Improve parser ui text display ([#1437](https://github.com/mealie-recipes/mealie/issues/1437)) - - diff --git a/docs/docs/changelog/v1.0.0beta-5.md b/docs/docs/changelog/v1.0.0beta-5.md deleted file mode 100644 index 2f25e08bf2b..00000000000 --- a/docs/docs/changelog/v1.0.0beta-5.md +++ /dev/null @@ -1,3 +0,0 @@ -### NOTICE: - -Release changelogs are now published on github releases. This file is kept for historical purposes. diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 49a071ab92d..d1d881a2b24 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -98,23 +98,7 @@ nav: - Developers Guide: - Code Contributions: "contributors/developers-guide/code-contributions.md" - Dev Getting Started: "contributors/developers-guide/starting-dev-server.md" + - Database Changes: "contributors/developers-guide/database-changes.md" - Maintainers Guide: "contributors/developers-guide/maintainers.md" - Guides: - Improving Ingredient Parser: "contributors/guides/ingredient-parser.md" - - - Change Log: - - v1.0.0beta-5: "changelog/v1.0.0beta-5.md" - - v1.0.0beta-4: "changelog/v1.0.0beta-4.md" - - v1.0.0beta-3: "changelog/v1.0.0beta-3.md" - - v1.0.0beta-2: "changelog/v1.0.0beta-2.md" - - v1.0.0 Beta: "changelog/v1.0.0.md" - - v0.5.2 Misc Updates: "changelog/v0.5.2.md" - - v0.5.1 Bug Fixes: "changelog/v0.5.1.md" - - v0.5.0 General Upgrades: "changelog/v0.5.0.md" - - v0.4.3 Hot Fix: "changelog/v0.4.3.md" - - v0.4.2 Backend/Migrations: "changelog/v0.4.2.md" - - v0.4.1 Frontend/UI: "changelog/v0.4.1.md" - - v0.4.0 Authentication: "changelog/v0.4.0.md" - - v0.3.0 Improvements: "changelog/v0.3.0.md" - - v0.2.0 Now With Tests!: "changelog/v0.2.0.md" - - v0.1.0 Beta: "changelog/v0.1.0.md"