Move docs folder #506
Move docs folder #506
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## development #506 +/- ##
===============================================
- Coverage 79.01% 79.00% -0.01%
===============================================
Files 263 263
Lines 14839 14833 -6
===============================================
- Hits 11725 11719 -6
Misses 3114 3114
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
|
@pchtsp do you want to review the docs/source/main/install.rst file? |
docs/source/main/install.rst
Outdated
|
|
||
| flask db upgrade -d cornflow/migrations | ||
| flask access_init | ||
| flask creare_admin_user -u admin -e admin@cornflow.org -p Adminpassword1! |
There was a problem hiding this comment.
creare_admin_user --> create_admin_user
docs/source/main/install.rst
Outdated
|
|
||
| git clone https://github.com/baobabsoluciones/cornflow | ||
|
|
||
| Then we are going to need some files to have, that can be modified to alter how the deployment is going to work. |
There was a problem hiding this comment.
"Then we are going to need some files to have" sounds a bit weird
docs/source/main/install.rst
Outdated
| Then we need a docker-compose file. The ``docker-compose.yml`` or ``docker-compose-cornflow-celery.yml`` that are in the root folder of the repository can be used with some small tweaks to build the images from the local repo instead that taking the official images. | ||
|
|
||
| The changes needed to be done are just to comment lines 33-34 and 63-64 and uncomment lines 35-36 and 65-66. Then we can run the following commands to start up the containers:: |
There was a problem hiding this comment.
instead of putting the line numbers, I recommend including the text to change in this file. That way if the lines change, the reference still works. Also, it's not clear if the file to change is docker-compose.yml or docker-compose-cornflow-celery.yml or if it matters.
docs/source/main/install.rst
Outdated
| If we want to have the full ecosystem to test out the celery backend, then we have to run the ``docker-compose-cornflow-celery.yml`` file instead of the ``docker-compose.yml`` file. This will start up a redis instance and a celery worker that will be used by airflow to run the DAGs. | ||
|
|
||
| To use this docker-compose file we need to comment lines 33-34 and 67-68 | ||
| and uncomment lines 35-36 and 69-70. |
There was a problem hiding this comment.
now I get it. Maybe make it more explicit above. Also, the same applies as per the line number references.
| Docker. Pull images from docker hub | ||
| ------------------------------------ | ||
|
|
||
| To run the environment with the official images then we just have to copy the ``docker-compose.yml`` or ``docker-compose-cornflow-celery.yml`` file to our system and run the docker-compose up command to use the official docker hub images. | ||
|
|
There was a problem hiding this comment.
maybe this option should appear before the previous one? it seems a lot easier. It could be:
- if you want to use the official docker images -> run these commands.
- if you want to use the development version -> run these commands.
There was a problem hiding this comment.
It's a posibility. But I believe the purpose of this specific documentation is build from Dockerfile.
Maybe it would be nice to have a quick deployment paragraph before all this documentation with the command:
docker-compose up -d
| - rq02: "soft", "strict" or "deactivated for the weekly hours constraint | ||
| - rq03: "soft", "strict" or "deactivated for the maximum daily hours constraint | ||
| - rq05: "soft", "strict" or "deactivated for the maximum days worked per week constraint | ||
| - rq06: "soft", "strict" or "deactivated for the minimum daily hours constraint | ||
| - rq07: "soft", "strict" or "deactivated for the minimum rest hours between shifts constraint | ||
| - rq08: "soft", "strict" or "deactivated for the constraint about needing to have a manager in the store at all times | ||
| - rq09: "soft", "strict" or "deactivated for the skills constraint | ||
| - rq10: "soft", "strict" or "deactivated for the employees' holidays constraint | ||
| - rq11: "strict" or "deactivated for the store holidays constraint | ||
| - rq12: "strict" or "deactivated for the employee downtime constraint | ||
| - rq13: "soft", "strict" or "deactivated for the employee start hour preferences constraint | ||
| - rq14: "soft", "strict" or "deactivated for the employee max preference hours constraint | ||
| - rq15: "soft", "strict" or "deactivated for the employee schedule constraint | ||
| - rq16: "soft", "strict" or "deactivated for the fixed worktable constraint |
There was a problem hiding this comment.
"deactivated => "deactivated"
Solves issue #495
Moved documentation from inside cornflow-server folder to root folder.
Updated documentation.
Changed documentation theme.