Create a Guide/Template: Using Docker #68

Overview

We need to create a guide for beginner developers to setup their environments using Docker.

Action Items

The phases in the guide-making process are listed below. Each phase displayed in blue is linked to a wiki page with instructions on how to complete that phase. Open the wiki page in a new tab, copy the instructions for each part into the section labeled 'Tasks' at the bottom of this issue, and complete each task listed.

• Gather Examples Solo (open in a new tab)
• Gather Examples Collaboratively
• Create a Guide Draft
  • If needed, create a template
• Have your guide peer reviewed
• Present your guide for leadership review

Resources/Instructions

• Google Drive Folder for this Guide’s documents and shortcuts (to documents in other locations) 0068 [DRAFT] Using Docker

Active without Docker documentation

311-report:
No file

Active with Docker documentation

• Hack for LA's Website

  • config.docker.yml
  • docker-compose.yml
  • Readme.md (has no docker info)
  • CONTRIBUTING.md, Docker section
  • [INSTALL.md] There is no INSTALL.md file as of Jul 13 2022
  • WIKI The only instructions is this: Add local user accounts to the docker users group on Windows 10

• Food Oasis

  • Dockerfile, most recent
  • Dockerfile-jared, seems like an old test
  • docker-compose.yml
  • Deployment workflows build and deploy docker image to dockerhub on push to main and develop branch, then deploy the image to heroku in separate scripts
  • README.md: has no docker info as of 2022-02-11
  • CONTRIBUTING.md there is no contributing file as of 2022-02-11
  • INSTALL.md there is no install file as of 2022-02-14
  • WIKI: https://github.com/hackforla/food-oasis/wiki/Docker

• VRMS

  • Dockerfile
    • backend
      • Dockerfile.api
      • Dockerfile.dev
      • Dockerfile.prod
    • client
      • Dockerfile.client
      • Dockerfile.dev
      • Dockerfile.prod
    • nginx
      • Dockerfile.nginx
  • Deployment workflows
    • aws-backend-deploy.yml
    • aws-frontend-deploy.yml
  • docker-compose.yml
  • README.md: does not mention docker
  • CONTRIBUTING.md there is no contributing file as of 2022-02-14
  • INSTALL.md there is no install file as of 2022-02-14
  • WIKI

• TDM Calculator

  • Dockerfile
  • [docker-compose.yml] there is no docker-compose file as of 2022-02-14
  • docker.yaml build and push docker image on push to experimental, develop, and main branches
  • [README.md] does not mention docker
  • [CONTRIBUTING.md] points to the wiki
  • [INSTALL.md] there is no INSTALL.md file as of Jul 13 2022
  • WIKI:
    • Local Database has instructions on settin g up a local SQL Server in docker in Window/OSX/Linux, instructions on setting up the databse, and docker tips
    • Deployment has instructions on Azure deployment

• HomeUniteUs

  • [config.docker.yml] there is no config.docker.yml file as of 2022-02-11
  • .dockerignore
  • Dockerfile
  • docker-compose.yml
  • README.md, is empty as of 2022-02-11
  • [CONTRIBUTING.md] there is no contributing file as of 2022-02-11
  • [INSTALL.md] has not been checked
  • WIKI: [URL] has not been checked

• BallotNav

  • [config.docker.yml] has not been checked
  • [docker-compose.yml] has not been checked
  • [docker-compose.yml] has not been checked
  • README.md backend
  • [CONTRIBUTING.md] has not been checked
  • [INSTALL.md] has not been checked
  • WIKI: [URL] has not been checked

• 100 Automations

  • [config.docker.yml] has not been checked
  • [.dockerignore] has not been checked
  • [docker-compose.yml] has not been checked
  • [Dockerfile] has not been checked
  • [README.md] has not been checked
  • CONTRIBUTING.md
  • WIKI: [URL] has not been checked

• Engage (its own GitHub org)

  • engage-backend

    • [config.docker.yml] has not been checked
    • [.dockerignore] has not been checked
    • [docker-compose.yml] has not been checked
    • [Dockerfile] has not been checked
    • [README.md] has not been checked
    • [CONTRIBUTING.md] has not been checked
    • [INSTALL.md] has not been checked
    • WIKI: [URL] has not been checked

  • council-portal

    • [config.docker.yml] has not been checked
    • [.dockerignore] has not been checked
    • [docker-compose.yml] has not been checked
    • [Dockerfile] has not been checked
    • [README.md] has not been checked
    • [CONTRIBUTING.md] has not been checked
    • [INSTALL.md] has not been checked
    • WIKI: [URL] has not been checked

  • engage-scraper

    • [config.docker.yml] has not been checked
    • [.dockerignore] has not been checked
    • [docker-compose.yml] has not been checked
    • [Dockerfile] has not been checked
    • [README.md] has not been checked
    • [CONTRIBUTING.md] has not been checked
    • [INSTALL.md] has not been checked
    • WIKI: [URL] has not been checked

  • engage-scheduler

    • [config.docker.yml] has not been checked
    • [.dockerignore] has not been checked
    • [docker-compose.yml] has not been checked
    • [Dockerfile] has not been checked
    • [README.md] has not been checked
    • [CONTRIBUTING.md] has not been checked
    • [INSTALL.md] has not been checked
    • WIKI: [URL] has not been checked

  • Engage-docker

    • [config.docker.yml] has not been checked
    • [.dockerignore] has not been checked
    • [docker-compose.yml] has not been checked
    • [Dockerfile] has not been checked
    • README.md has not been checked
    • [CONTRIBUTING.md] has not been checked
    • [INSTALL.md] has not been checked
    • WIKI: [URL] has not been checked

• Civic Tech Index (its own GitHub org)

  • CTI-website-frontend

    • [config.docker.yml] has not been checked
    • [.dockerignore] has not been checked
    • [docker-compose.yml] has not been checked
    • [Dockerfile] has not been checked
    • [README.md] has not been checked
    • CONTRIBUTING.md , docker section
    • [INSTALL.md] has not been checked
    • WIKI: [URL] has not been checked

  • CTI-website-backend

    • [config.docker.yml] has not been checked
    • [.dockerignore] has not been checked
    • [docker-compose.yml] has not been checked
    • [Dockerfile] has not been checked
    • README.md
    • [CONTRIBUTING.md] has not been checked
    • [INSTALL.md] has not been checked
    • WIKI: [URL] has not been checked

• Getting-started

  • [config.docker.yml] has not been checked
  • [.dockerignore] has not been checked
  • [docker-compose.yml] has not been checked
  • [Dockerfile] has not been checked
  • [README.md] has not been checked
  • [CONTRIBUTING.md] has not been checked
  • [INSTALL.md] has not been checked
  • Using-docker.md
  • WIKI: [URL] has not been checked

• [311 Data](https://github.com/hackforla/311-data

  • [config.docker.yml] has not been checked
  • [.dockerignore] has not been checked
  • [docker-compose.yml] has not been checked
  • [Dockerfile] has not been checked
  • [README.md] has not been checked
  • [CONTRIBUTING.md] has not been checked
  • [INSTALL.md] has not been checked
  • WIKI: [URL] has not been checked

• Access the Data

  • [config.docker.yml] has not been checked
  • [.dockerignore] has not been checked
  • [docker-compose.yml] has not been checked
  • [Dockerfile] has not been checked
  • [README.md] has not been checked
  • [CONTRIBUTING.md] has not been checked
  • [INSTALL.md] has not been checked
  • WIKI: [URL] has not been checked

• Civic Tech Jobs

  • [config.docker.yml] has not been checked
  • [.dockerignore] has not been checked
  • [docker-compose.yml] has not been checked
  • [Dockerfile] has not been checked
  • [README.md] has not been checked
  • [CONTRIBUTING.md] has not been checked
  • [INSTALL.md] has not been checked
  • WIKI: [URL] has not been checked

• Data Science Projects

  • [config.docker.yml] has not been checked
  • [.dockerignore] has not been checked
  • [docker-compose.yml] has not been checked
  • [Dockerfile] has not been checked
  • [README.md] has not been checked
  • [CONTRIBUTING.md] has not been checked
  • [INSTALL.md] has not been checked
  • WIKI: [URL] has not been checked

• Design Systems

  • [config.docker.yml] has not been checked
  • [.dockerignore] has not been checked
  • [docker-compose.yml] has not been checked
  • [Dockerfile] has not been checked
  • [README.md] has not been checked
  • [CONTRIBUTING.md] has not been checked
  • [INSTALL.md] has not been checked
  • WIKI: [URL] has not been checked

• Expunge-Assist (formerly known as Record Clearance)

  • [config.docker.yml] has not been checked
  • [.dockerignore] has not been checked
  • [docker-compose.yml] has not been checked
  • [Dockerfile] has not been checked
  • [README.md] has not been checked
  • [CONTRIBUTING.md] has not been checked
  • [INSTALL.md] has not been checked
  • WIKI: [URL] has not been checked

• GreenEarthOS

  • [config.docker.yml] has not been checked
  • [.dockerignore] has not been checked
  • [docker-compose.yml] has not been checked
  • [Dockerfile] has not been checked
  • [README.md] has not been checked
  • [CONTRIBUTING.md] has not been checked
  • [INSTALL.md] has not been checked
  • WIKI: [URL] has not been checked

• Guides

  • [config.docker.yml] has not been checked
  • [.dockerignore] has not been checked
  • [docker-compose.yml] has not been checked
  • [Dockerfile] has not been checked
  • [README.md] has not been checked
  • [CONTRIBUTING.md] has not been checked
  • [INSTALL.md] has not been checked
  • WIKI: [URL] has not been checked

• Internship project

  • [config.docker.yml] has not been checked
  • [.dockerignore] has not been checked
  • [docker-compose.yml] has not been checked
  • [Dockerfile] has not been checked
  • [README.md] has not been checked
  • [CONTRIBUTING.md] has not been checked
  • [INSTALL.md] has not been checked
  • WIKI: [URL] has not been checked

• Lucky Parking

  • [config.docker.yml] has not been checked
  • [.dockerignore] has not been checked
  • [docker-compose.yml] has not been checked
  • [Dockerfile] has not been checked
  • [README.md] has not been checked
  • [CONTRIBUTING.md] has not been checked
  • [INSTALL.md] has not been checked
  • WIKI: [URL] has not been checked

• Open Community Survey

  • [config.docker.yml] has not been checked
  • [.dockerignore] has not been checked
  • [docker-compose.yml] has not been checked
  • [Dockerfile] has not been checked
  • [README.md] has not been checked
  • [CONTRIBUTING.md] has not been checked
  • [INSTALL.md] has not been checked
  • WIKI: [URL] has not been checked

• Youth Justice Nav

  • [config.docker.yml] has not been checked
  • [.dockerignore] has not been checked
  • [docker-compose.yml] has not been checked
  • [Dockerfile] has not been checked
  • [README.md] has not been checked
  • [CONTRIBUTING.md] has not been checked
  • [INSTALL.md] has not been checked
  • WIKI: [URL] has not been checked

Inactive Projects

Inactive with Docker files

• Ohana Web Search
  • ohana-api-la
    • [config.docker.yml] has not been checked
    • [.dockerignore] has not been checked
    • [docker-compose.yml] has not been checked
    • [Dockerfile] has not been checked
    • [README.md] has not been checked
    • [CONTRIBUTING.md] has not been checked
    • INSTALL.md
    • WIKI: [URL] has not been checked
  • ohana-web-search-la
    • [config.docker.yml] has not been checked
    • [.dockerignore] has not been checked
    • [docker-compose.yml] has not been checked
    • [Dockerfile] has not been checked
    • [README.md] has not been checked
    • [CONTRIBUTING.md] has not been checked
    • INSTALL.md
    • WIKI: [URL] has not been checked
• Spare
  • [config.docker.yml] has not been checked
  • [.dockerignore] has not been checked
  • [docker-compose.yml] has not been checked
  • [Dockerfile] has not been checked
  • README.md
  • [CONTRIBUTING.md] has not been checked
  • WIKI: [URL] has not been checked
• Heart
  • [config.docker.yml] has not been checked
  • [.dockerignore] has not been checked
  • [docker-compose.yml] has not been checked
  • [Dockerfile] has not been checked
  • README.md
  • [CONTRIBUTING.md] has not been checked
  • WIKI: [URL] has not been checked
  • Notes: could not find installation file
• RailStats LA aka Metro-ontime
  • performance_tracker
    • [config.docker.yml] has not been checked
    • [.dockerignore] has not been checked
    • [docker-compose.yml] has not been checked
    • [Dockerfile] has not been checked
    • [README.md](https://github.com/metro- ontime/performance_tracker/blob/master/README.md)
    • [CONTRIBUTING.md] has not been checked
    • WIKI: [URL] has not been checked
  • railstats_api
    • [config.docker.yml] has not been checked
    • [.dockerignore] has not been checked
    • [docker-compose.yml] has not been checked
    • [Dockerfile] has not been checked
    • README.md
    • [CONTRIBUTING.md] has not been checked
    • WIKI: [URL] has not been checked
• project-light-the-way
  • [config.docker.yml] has not been checked
  • [.dockerignore] has not been checked
  • [docker-compose.yml] has not been checked
  • [Dockerfile] has not been checked
  • [README.md] has not been checked
  • [CONTRIBUTING.md] has not been checked
  • WIKI: [URL] has not been checked
• citygram
  • [config.docker.yml] has not been checked
  • [.dockerignore] has not been checked
  • [docker-compose.yml] has not been checked
  • [Dockerfile] has not been checked
  • [README.md] has not been checked
  • [CONTRIBUTING.md] has not been checked
  • WIKI: [URL] has not been checked
• helloGov (its own GitHub org)
  • webapp
    • [config.docker.yml] has not been checked
    • [.dockerignore] has not been checked
    • [docker-compose.yml] has not been checked
    • [Dockerfile] has not been checked
    • README.md
    • [CONTRIBUTING.md] has not been checked
    • WIKI: [URL] has not been checked
• Shared Housing
  • [config.docker.yml] has not been checked
  • [.dockerignore] has not been checked
  • [docker-compose.yml] has not been checked
  • [Dockerfile] has not been checked
  • [README.md] has not been checked
  • [CONTRIBUTING.md] has not been checked
  • WIKI: [URL] has not been checked

Projects to Check

• Docker Template Guide Draft
• Ops Google Drive folder for Docker Guide

Tasks

• This is where you will copy instructions from the wiki page for the step you are currently on.