updating docs and moving sample files into there own dir

open-eats · Feb 4, 2018 · d342df6 · d342df6
1 parent b649f96
commit d342df6
Show file tree

Hide file tree

Showing 7 changed files with 10 additions and 18 deletions.
diff --git a/docs/Creating_a_proxy_server_for_docker.md b/docs/Creating_a_proxy_server_for_docker.md
@@ -1,25 +1,17 @@
 # Serving with a proxy server and HTTPS
- By default the docker applacition doesn't come with an https server. It is also likely that you want to server other applcaitions.
+ By default the docker application doesn't come with an https server. It is also likely that you want to server other applications.
 
- If you want to server the docker applciation via https or serve mutliple appcations via nginx/apache then you will also need a proxy server.
+ If you want to server the docker application via https or serve multiple applications via nginx/apache then you will also need a proxy server.
 
- To change the port from which OpenEats is serverd you will need to update the left side of the port configuration.
- - Open the docker-prod.yml (your docker-compose configuration) file.
+ To change the port from which OpenEats is served you will need to update the left side of the port configuration.
+ - Open the docker-prod.override.yml (your docker-compose configuration) file.
  - To serve the app via port 7000:
 ``` yml
+version: '2.3'
+services:
   nginx:
-    image: openeats/nginx
-    command: ./start.sh
     ports:
       - "7000:80"
-    volumes:
-      - static-files:/var/www/html/openeats-static/static-files
-      - site-media:/var/www/html/openeats-static/site-media
-    depends_on:
-      - api
-      - web
-    env_file:
-      env_prod.list
 ```
 
 - Restart you docker containers `docker-compose -f docker-prod.yml restart`

diff --git a/docs/Running_the_App.md b/docs/Running_the_App.md
@@ -15,11 +15,11 @@ Then, create two files from the sample files:
 - env_prod.list
 
 ```bash
-cp docker-prod.override.yml docs/sample_docker_prod_override.yml
-cp env_prod.list docs/sample_env_file.list
+cp docker-prod.override.yml docs/sample/sample_docker_prod_override.yml
+cp env_prod.list docs/sample/sample_env_file.list
 ```
 
-The `docker-prod.override.yml` contains the list of images to run the app. It comes with an nginx reverse proxy that by default will run on port 80. You will most likely want to change the port that nginx runs on as well as use a fix tag for the image. By default, all are set to latest.
+The `docker-prod.override.yml` specifies the port that OpenEats is served from as well as any override commands you have. The nginx reverse proxy will default to run on port 80. You will most likely want to change the port that nginx runs on. See [Creating a proxy serve for docker](Creating_a_proxy_server_for_docker.md) for more information on how to configure an nginx server to serve OpenEats.
 
 #### Configure the environment file
 Most of the settings in your `env_prod.list` can stay the same as `env_stg.list` that is in this repo. There are a few config settings that need to be changed for most configurations. See [Setting_up_env_file.md](Setting_up_env_file.md) for a complete description of the environment variables.

diff --git a/docs/Running_the_App_in_dev.md b/docs/Running_the_App_in_dev.md
@@ -4,7 +4,7 @@ The recommended way to run this app is with docker. You can install docker [here
 
 ### Running the app with docker for development
 
-First you'll need to fork the appropriate repo that you are looking to make changes to.
+First you'll need to fork the appropriate repo that you are looking to make changes to, alone witht he core repo. See below for a sample.
 
 ```bash
 git clone https://github.com/open-eats/OpenEats.git

diff --git a/docs/sample_docker_prod_override.yml → docs/samples/sample_docker_prod_override.yml b/docs/sample_docker_prod_override.yml → docs/samples/sample_docker_prod_override.yml
diff --git a/docs/sample_docker_prod_version.yml → docs/samples/sample_docker_prod_version.yml b/docs/sample_docker_prod_version.yml → docs/samples/sample_docker_prod_version.yml
diff --git a/docs/sample_env_file.list → docs/samples/sample_env_file.list b/docs/sample_env_file.list → docs/samples/sample_env_file.list
diff --git a/docs/sample_nginx_proxy → docs/samples/sample_nginx_proxy b/docs/sample_nginx_proxy → docs/samples/sample_nginx_proxy