hackforla / hackforla/knowledgebase-content

Create a Guide/Template: Hosting for your project

Open
#70 5 comments 0 reactions 0 assignees View on GitHub
Complexity: Missing CoP label: checked CoP label: shortcuts added CoP: Engineering CoP: Ops CoP: Product feature : guide creation Phase: 1 - Gather Examples Solo Ready for Bonnie Triage size: 2pt status: 1.1 needs wiki examples status: 1.2 needs issues examples status: 1.3 needs project board examples status: 1.4 needs slack examples
Dominant language
No language data
Stars
2
Forks
1
PR merge metrics
No merged PRs in 30d

Description

### 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](https://github.com/hackforla/guides/wiki/How-to-Gather-Examples:-Solo) (open in a new tab)
- [ ] [Gather Examples Collaboratively](https://github.com/hackforla/guides/wiki/Phase-2-%E2%80%90-Gather-Examples-Collaboratively)
- [ ] [Create a Guide Draft](https://github.com/hackforla/guides/wiki/How-to-Draft-a-Guide)
- [ ] If needed, create a template
- [ ] [Have your guide peer reviewed](https://github.com/hackforla/guides/wiki/Peer-Reviews-for-Guides)
- [ ] [Present your guide for leadership review](https://github.com/hackforla/guides/wiki/Submitting-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 ](https://drive.google.com/drive/folders/1zH8g7XUV8cCx03cWeZIknavow51q9_7y)

#### 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

- https://github.com/hackforla/incubator/issues/120
- https://github.com/hackforla/knowledgebase-content/issues/68

### Projects to Check
See [Hosting platform needs by project](https://docs.google.com/spreadsheets/d/1sYaVNwwZG2QHKPYvscpJv-Lk1fFABTCb_CF7mf7n01M/edit#gid=0) - 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.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.