wbrawner/mealie
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

fix docs (#505)

Browse source 
* fix docs

* undo makefile alignment

Co-authored-by: Hayden <64056131+hay-kot@users.noreply.github.com>
This commit is contained in:
wengtad 2021-06-13 15:20:43 +08:00 committed by GitHub
parent d28fe9833d
commit 27bf3802fe
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
6 changed files with 21 additions and 21 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
README.md
View file

@ -32,7 +32,7 @@
·
<a href="https://github.com/hay-kot/mealie/issues">Report Bug</a>
·
<a href="https://hay-kot.github.io/mealie/api/docs/">API</a>
<a href="https://hay-kot.github.io/mealie/api/redoc/">API</a>
·
<a href="https://github.com/hay-kot/mealie/issues">
Request Feature
@ -96,7 +96,7 @@ As to why we need a database?
<!-- CONTRIBUTING -->
## Contributing
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**. Especially test. Literally any tests. See the [Contributors Guide](https://hay-kot.github.io/mealie/contributors/developers-guide/code-contributions/) for help getting started.
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**. Especially test. Literally any tests. See the [Contributors Guide](https://hay-kot.github.io/mealie/contributors/non-coders/) for help getting started.
If you are not a coder, you can still contribute financially. financial contributions help me prioritize working on this project over others and helps me know that there is a real demand for project development.

20
docs/docs/contributors/developers-guide/starting-dev-server.md
View file

@ -1,6 +1,6 @@
# Development: Getting Started
After reading through the [Code Contributions Guide](https://hay-kot.github.io/mealie/contributors/developers-guide/code-contributions/){:target="_blank"} and forking the repo you can start working. This project is developed with :whale: docker and as such you will be greatly aided by using docker for development. It's not necessary but it is helpful.
After reading through the [Code Contributions Guide](../developers-guide/code-contributions.md) and forking the repo you can start working. This project is developed with :whale: docker and as such you will be greatly aided by using docker for development. It's not necessary but it is helpful.
## With Docker
Prerequisites
@ -25,18 +25,18 @@ Once the prerequisites are installed you can cd into the project base directory
Run `make help` for reference
```
clean-purge ⚠️ Removes All Developer Data for a fresh server start
clean 🧹 remove all build, test, coverage and Python artifacts
clean-pyc 🧹 remove Python file artifacts
clean-test 🧹 remove test and coverage artifacts
clean-purge ⚠️ Removes All Developer Data for a fresh server start
clean 🧹 Remove all build, test, coverage and Python artifacts
clean-pyc 🧹 Remove Python file artifacts
clean-test 🧹 Remove test and coverage artifacts
test-all 🧪 Check Lint Format and Testing
test 🧪 run tests quickly with the default Python
lint 🧺 check style with flake8
coverage ☂️ check code coverage quickly with the default Python
setup 🏗 Setup Development Instance
test 🧪 Run tests quickly with the default Python
lint 🧺 Check style with flake8
coverage ☂️ Check code coverage quickly with the default Python
setup 🏗 Setup Development Instance
backend 🎬 Start Mealie Backend Development Server
frontend 🎬 Start Mealie Frontend Development Server
frontend-build 🏗 Build Frontend in frontend/dist
frontend-build 🏗 Build Frontend in frontend/dist
docs 📄 Start Mkdocs Development Server
docker-dev 🐳 Build and Start Docker Development Stack
docker-prod 🐳 Build and Start Docker Production Stack

2
docs/docs/documentation/admin/backups-and-exports.md
View file

@ -3,7 +3,7 @@
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.
!!! danger
As this is still a **BETA** It is recommended that you backup your data often and store in more than one place. Ad-hear to backup best practices with the [3-2-1 Backup Rule](https://en.wikipedia.org/wiki/Backup). Prior to upgrading you **should** perform a backup to limit any data loss.
As this is still a **BETA** It is recommended that you backup your data often and store in more than one place. Ad-hear to backup best practices with the [3-2-1 Backup Rule](https://en.wikipedia.org/wiki/Backup){:target="_blank"}. Prior to upgrading you **should** perform a backup to limit any data loss.
!!! tip "Mealie data that is saved on backups"
- [x] Recipe Data

2
docs/docs/documentation/admin/building-pages.md
View file

@ -1,7 +1,7 @@
# Building Pages
!!! warning
The page building is still experimental and may change. You can provide feedback on any changes you'd like to see on [github](https://github.com/hay-kot/mealie/discussions/229)
The page building is still experimental and may change. You can provide feedback on any changes you'd like to see on [github](https://github.com/hay-kot/mealie/discussions/229){:target="_blank"}
Custom pages can be created to organize multiple categories into a single page. Links to your custom pages are displayed on the home page sidebar and accessible by all users, however only Administrators can create or update pages.
![custom page](../../assets/img/custom-page.webp)

2
docs/docs/documentation/admin/dashboard.md
View file

@ -9,7 +9,7 @@ The dashboard gives you a quick overview of how your Mealie is doing. There is a
'Recipes' shows how many recipes you have in your catalogue but also checks if you have any untagged or uncategorized ones. If you click on one of these, you are redirected to the Toolbox where you can further organize these recipes.
## Users
This gives an overview of the total number of users for your Mealie instance. The 'manage users' and 'manage groups' button will redirect you to the [user-management page](../admin/dashboard.md)
This gives an overview of the total number of users for your Mealie instance. The 'manage users' and 'manage groups' button will redirect you to the [user-management page](../admin/user-management.md).
## Backups
Here you can choose to import an older backup from a previous instance. You could also create a custom backup with your own tag where you can choose for a full backup or only some parts like recipes, users,...

12
makefile
View file

@ -30,15 +30,15 @@ purge: clean ## ⚠️ Removes All Developer Data for a fresh server start
rm -f ./dev/data/mealie.log
rm -f ./dev/data/.secret
clean: clean-pyc clean-test ## 🧹 remove all build, test, coverage and Python artifacts
clean: clean-pyc clean-test ## 🧹 Remove all build, test, coverage and Python artifacts
clean-pyc: ## 🧹 remove Python file artifacts
clean-pyc: ## 🧹 Remove Python file artifacts
find . -name '*.pyc' -exec rm -f {} +
find . -name '*.pyo' -exec rm -f {} +
find . -name '*~' -exec rm -f {} +
find . -name '__pycache__' -exec rm -fr {} +
clean-test: ## 🧹 remove test and coverage artifacts
clean-test: ## 🧹 Remove test and coverage artifacts
rm -fr .tox/
rm -f .coverage
rm -fr htmlcov/
@ -46,15 +46,15 @@ clean-test: ## 🧹 remove test and coverage artifacts
test-all: lint test ## 🧪 Check Lint Format and Testing
test: ## 🧪 run tests quickly with the default Python
test: ## 🧪 Run tests quickly with the default Python
poetry run pytest
lint: ## 🧺 check style with flake8
lint: ## 🧺 Check style with flake8
poetry run black .
poetry run black . --check
poetry run flake8 mealie tests
coverage: ## ☂️ check code coverage quickly with the default Python
coverage: ## ☂️ Check code coverage quickly with the default Python
poetry run pytest
coverage report -m
coverage html