Create a Guide/Template: Hosting for your project

[erigilg]

Overview

We need to create a beginners guide to hosting your project in GitHub (free), or if it requires an obscured backend how to connect with DevOps to host on our AWS incubator so that teams know how to host their projects.

Details

obscured backend = 311 Data and the Hack for LA website are the teams that use GitHub both for front end and for backend (data storage), because the data they store is not private, they are able to store it in a GitHub repo. If you have a project that has information that you must keep private (PII), then you would need an account on our AWS incubator.

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) 0070 [DRAFT] Hosting for your project

Guide should cover

MVP

• Overview of how Hack for LA hosts websites
  • Incubator
  • Solo Instances
• Why you can't host the project on free tier of Heroku
• Information checklist that a project will need in order to get the ops team involved
  • item 1
  • item2
  • prerequisites
• What to do if you are having trouble gathering info for the checklist
• Meeting with the ops team
• links to other guides
  • how to provision a project on incubator
  • how to provision a site as a solo instance
  • security for your hosting
  • how to get added to 1password
  • ssl certs

Related Issues

• Document setting up individual projects CI/CD pipeline to AWS Incubator using GitHub actions and Docker ops#32
• Create a Guide/Template: Using Docker #68

Projects to Check

See Hosting platform needs by project - You need access to the DevOps Community of Practice drive to access this file.
It is likely out of date, see DevOps CoP for updated list

Tasks

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

[Aditya23soni]

Prior version of issue

Dependency

• Create Guide for setting up project.hcl for deploying on Incubator ops#31
• Determine project.hcl workflow and setup incubator#55
• Document setting up individual projects CI/CD pipeline to AWS Incubator using GitHub actions and Docker ops#32
• Create a Guide/Template: Using Docker #68

Overview

We need to create a guide to hosting your project in Github (free), Heroku or AWS so that teams know how to host their projects.

Action Items

• Gather examples of how other projects have done, adding each example as a link in the resources section (in this case, if they are on AWS, which instance incubator or solo).
  • Once done, remove the "TG: Gather Examples" label and add the "TG: Draft Template" label
• Create a draft template, either in markdown format in this issue or a google doc in the product management google drive
  • Once done, remove the "TG: Draft Template" label and add the "TG: Create Guide" label
• Create a guide on how to use the template
  • Once done, remove the "TG: Create Guide" label and add the "TG: Review Guide" label
• Review the guide with product management communities of practice
  • Once done, remove the "TG: Review Guide" label and add the "TG: Leadership Review" label
• Present to Hack for LA leadership team for sign off
  • Once approved, remove the "TG: Leadership Review" label and add the "TG: Place Guide" label
• Possibly create an issue template on .github
  • Include link to template under resources if you add it as a template in .github

Resources

Update issue #104 with the name of item you are working
Guide [url]

Projects to check

See Hosting platform needs by project

[Aditya23soni]

Assignee, Labels, Project Board Placement, and Milestones for this issue in the Ops Repo: