From c3ca1486a505176e6379276870a148a7e3d54af3 Mon Sep 17 00:00:00 2001 From: Marlan McInnes-Taylor Date: Thu, 9 May 2024 13:24:52 -0500 Subject: [PATCH] restructured deploy directory --- CONTRIBUTING.md | 2 +- README.md | 2 +- deploy/{dev => }/docker-compose.yml | 2 +- docs/index.md | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) rename deploy/{dev => }/docker-compose.yml (99%) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e5cd4f8..8205eab 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -82,7 +82,7 @@ Programming-Contest-Suite/ ## Testing & Development Server -`deploy/dev/docker-compose.yml` contains an example deployment intended for [Docker Compose](https://docs.docker.com/compose/) and suitable for local testing and development. +`deploy/docker-compose.yml` contains an example deployment intended for [Docker Compose](https://docs.docker.com/compose/) and suitable for local testing and development. If you are running the development deployment for the first time, or have made any changes to the project's Celery tasks, run: diff --git a/README.md b/README.md index 3045df2..323309e 100644 --- a/README.md +++ b/README.md @@ -48,7 +48,7 @@ There are many ways to [deploy Django](https://docs.djangoproject.com/en/4.2/how ### Docker -Please reference `docs/docker/` for image creation and usage documentation. Pre-built images are available in the project's [Docker Hub repository](https://hub.docker.com/r/acmfsu/contestsuite). Reference `deploy/dev/docker-compose.yml` for an example deployment intended for [Docker Compose](https://docs.docker.com/compose/) and suitable for local development and testing purposes. +Please reference `docs/docker/` for image creation and usage documentation. Pre-built images are available in the project's [Docker Hub repository](https://hub.docker.com/r/acmfsu/contestsuite). Reference `deploy/docker-compose.yml` for an example deployment intended for [Docker Compose](https://docs.docker.com/compose/) and suitable for local development and testing purposes. #### Default Superuser user: `contestadmin` diff --git a/deploy/dev/docker-compose.yml b/deploy/docker-compose.yml similarity index 99% rename from deploy/dev/docker-compose.yml rename to deploy/docker-compose.yml index 54316df..fe91b55 100644 --- a/deploy/dev/docker-compose.yml +++ b/deploy/docker-compose.yml @@ -3,7 +3,7 @@ version: '3.8' services: django: build: - context: ../.. + context: ../ args: REQUIREMENTS: requirements-dev.txt image: contestsuite:dev diff --git a/docs/index.md b/docs/index.md index f3bb775..308933d 100644 --- a/docs/index.md +++ b/docs/index.md @@ -28,7 +28,7 @@ There are many ways to [deploy Django](https://docs.djangoproject.com/en/4.2/how ### Docker -Please reference our [Docker image documentation]({{ site.url }}/docker.html) for creation and usage details. Pre-built images are available in the project's [Docker Hub repository](https://hub.docker.com/r/acmfsu/contestsuite). An example deployment intended for [Docker Compose](https://docs.docker.com/compose/) and suitable for local development and testing purposes is available in the repository's [deploy directory](https://github.com/mmcinnestaylor/Programming-Contest-Suite/tree/main/deploy/dev). +Please reference our [Docker image documentation]({{ site.url }}/docker.html) for creation and usage details. Pre-built images are available in the project's [Docker Hub repository](https://hub.docker.com/r/acmfsu/contestsuite). An example deployment intended for [Docker Compose](https://docs.docker.com/compose/) and suitable for local development and testing purposes is available in the repository's [deploy directory](https://github.com/mmcinnestaylor/Programming-Contest-Suite/tree/main/deploy). #### Default Superuser user: `contestadmin`