ER: docs: project `url fields` vs `project_url`

[fyliu]

Dependency

• Add name and external_id fields to project_url table #289
• Update project table: external id fields to point to project_url entries #290

Overview

As system designers, we need to document our original intent so that users will be clear on how to use the project. We need to decide how project url fields and project_url entries relate, what should go where, and document it.

• relates to Create Table: url_type #77, Create Table: project #16, Create Table: project_url #41

Action Items

• Decide what url data should go where
• Draft an explanation in this issue, maybe a new section under Resources
• Record it in the documentation under usage/setup/brigadeAdmin
  • include clarification on external_id field from this comment

We will be removing the url fields from the Project table. (From comment below)

• Add url type to url_type spreadsheet tab if it's not already there
• Update ERD and SS
• Create a new issue for updating the project table
• Create new issue for script to check repo urls and ids (see discussion summary section) Script to check id and url match for all projects #291

Resources/Instructions

• See the overlaps between the project table fields and the entries that can go into the url_type for the project_url table.
• 
• 
• Link to github API docs section on getting repo info
• useful command to get info about peopledepot project

  curl -L \
    -H "Accept: application/vnd.github+json" \
    -H "X-GitHub-Api-Version: 2022-11-28" \
    https://api.github.com/repos/hackforla/peopledepot

Summary of discussions

• The github_primary... is because some projects have separate frontend and backend repo, for example
• Github repo names can change (done by the project) but not the id
• We need to keep the github_primary_repo_id (id from the API response) and github_primary_repo_url (html_url) in the project for validation purposes
• We need a script to check (weekly?) that the id and url match for all the projects