diff --git a/docs/docs/changelog.md b/docs/docs/changelog.md index ab5f19dd5..8aca6a822 100644 --- a/docs/docs/changelog.md +++ b/docs/docs/changelog.md @@ -1,6 +1,11 @@ # Release Notes -## V0.2.0 - Now with Test! +## 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 @@ -10,29 +15,47 @@ - Fixed router link bugs - Issue #122 ### Features and Improvements - - UI Language Selection - - Meal Planner + - **Home Page** + - Sections: 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. + - Sidebar: 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. + - Sort: Basic Sort functionality has been added. More options are on the way! + - **Meal Planner** - Improved Search (Fuzzy Search) - New Scheduled card support - Upload/Download backups - - Dockerfile now 1/5 of the size! - - Migrations + - **Recipe Editor** + - Ingredients are now sortable via drag-and-drop + - Known categories now show up in the dropdown + - Initial code for data validation to prevent errors + - **Migrations** - Card based redesign - Upload from the UI - - Unified Chowdown/Nextcloud import process. + - 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. + - :whale: Dockerfile now 1/5 of the size! + - UI Language Selection + Additional Supported Language - 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 + - FastAPI Route tests for major operations - WIP (shallow testing) -### Breaking Changes - - Officially Dropped MongoDB Support - - Mounting volume moved to different internal location due to development issues. New volume should be mounted as `mealie/data:/app_data/` +### Breaking Changes + +!!! error "Breaking Changes" + - API endpoints have been refactored to adhear to a more consistent standard. This is a WIP and more changes are likely to occur. + - Officially Dropped MongoDB Support + - Mounting volume moved to different internal location due to development issues. New volume should be mounted as `mealie/data:/app_data/`. Volume mounts need to be changed. + - 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. ## v0.1.0 - Initial Beta ### Bug Fixes diff --git a/docs/docs/getting-started/backups-and-exports.md b/docs/docs/getting-started/backups-and-exports.md index 668ddb3e8..165226e89 100644 --- a/docs/docs/getting-started/backups-and-exports.md +++ b/docs/docs/getting-started/backups-and-exports.md @@ -1,4 +1,4 @@ -# Backup and Export +# Backup and Imports ![](../img/admin-backup.png) All recipe data can be imported and exported as necessary from the UI. Under the admin page you'll find the section for using Backups and Exports. diff --git a/docs/docs/getting-started/install.md b/docs/docs/getting-started/install.md index 8663fcd16..75aaee8ed 100644 --- a/docs/docs/getting-started/install.md +++ b/docs/docs/getting-started/install.md @@ -39,54 +39,11 @@ services: ``` - -## Docker Compose with Mongo - DEPRECIATED - -```yaml -# docker-compose.yml -version: "3.1" -services: - mealie: - container_name: mealie - image: hkotel/mealie:latest - restart: always - ports: - - 9000:80 - environment: - db_username: root # Your Mongo DB Username - Please Change - db_password: example # Your Mongo DB Password - Please Change - db_host: mongo - db_port: 27017 # The Default port for Mongo DB - TZ: America/Anchorage - volumes: - - ./mealie/data/:/app/data/ - - mongo: - image: mongo - restart: always - volumes: - - ./mongo:/data/db - environment: - MONGO_INITDB_ROOT_USERNAME: root # Change! - MONGO_INITDB_ROOT_PASSWORD: example # Change! - - mongo-express: # Optional Mongo GUI - image: mongo-express - restart: always - ports: - - 9091:8081 - environment: - ME_CONFIG_MONGODB_ADMINUSERNAME: root - ME_CONFIG_MONGODB_ADMINPASSWORD: example - -``` - - ## Env Variables | Variables | default | description | | -------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | -| db_type | sqlite | The database type to be used. Current Options 'sqlite' and 'mongo' | +| db_type | sqlite | The database type to be used. Current Options 'sqlite' | | mealie_db_name | mealie | The name of the database to be created in Mongodb | | mealie_port | 9000 | The port exposed by mealie. **do not change this if you're running in docker** If you'd like to use another port, map 9000 to another port of the host. | | db_username | root | The Mongodb username you specified in your mongo container | @@ -98,4 +55,4 @@ services: ## Deployed as a Python Application -Alternatively, this project is built on Python and Mongodb. If you are dead set on deploying on a linux machine you can run this in an python environment with a dedicated MongoDatabase. Provided that you know thats how you want to host the application, I'll assume you know how to do that. I may or may not get around to writing this guide. I'm open to pull requests if anyone has a good guide on it. \ No newline at end of file +Alternatively, this project is built on Python and Mongodb. If you are dead set on deploying on a linux machine you can run this in an python environment with a dedicated MongoDatabase. Provided that you know thats how you want to host the application, I'll assume you know how to do that. I may or may not get around to writing this guide. I'm open to pull requests if anyone has a good guide on it. diff --git a/docs/docs/getting-started/meal-planner.md b/docs/docs/getting-started/meal-planner.md index 8293aace7..e9d202adc 100644 --- a/docs/docs/getting-started/meal-planner.md +++ b/docs/docs/getting-started/meal-planner.md @@ -3,7 +3,7 @@ ## Working with Meal Plans In Mealie you can create a mealplan based off the calendar inputs on the meal planner page. There is no limit to how long or how short a meal plan is. You may also create duplicate meal plans for the same date range. After selecting your date range, click on the card for each day and search through recipes to find your choice. After selecting a recipe for all meals save the plan. You can also randomly generate meal plans. -To edit the meal in a meal plan simply select the edit button on the card in the timeline. Similiarly, to delete a mealplan click the delete button on the card in the timeline. Currently there is no support to change the date range in a meal plan. +To edit the meal in a meal plan simply select the edit button on the card in the timeline. Similarly, to delete a mealplan click the delete button on the card in the timeline. Currently there is no support to change the date range in a meal plan. !!! warning In coming a future release recipes for meals will be restricted to specific categories.