hackforla / hackforla/peopledepot

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

Open
#78 14 comments 0 reactions 0 assignees View on GitHub
complexity: missing dependency documentation ER feature: DB design feature: ERD/SS adjustment p-feature: projects PII: FALSE role: technical writing s: CTJ s: hackforla.org s: org s: VRMS size: 1pt
Dominant language
Python
Stars
14
Forks
37
Avg merge
9d 15h
Merged PRs (30d)
5

Description

### Dependency

- #289
- #607

### 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 #77, #16, #41

### Action Items

- [x] Decide what url data should go where
- [x] 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](https://github.com/hackforla/peopledepot/issues/78#issuecomment-1809287295)

We will be removing the url fields from the Project table. (From [comment](https://github.com/hackforla/peopledepot/issues/78#issuecomment-1701952674) below)

- [x] Add url type to url_type spreadsheet tab if it's not already there
- [x] Update ERD and SS
- [x] Create a new issue for updating the project table
- [x] Create new issue for script to check repo urls and ids (see discussion summary section) #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.
- ![2022-09-12 12 42 43 docs google com dd451c9e7fe3](https://user-images.githubusercontent.com/1160105/189743539-93cf69b0-9091-40d6-bd78-2b6886ce12de.png)
- ![2022-09-12 12 42 13 lucid app ad61fbe8b6f9](https://user-images.githubusercontent.com/1160105/189743549-571a1c64-a005-4d59-9d6c-d725daa450ca.png)
- [Link to github API docs section on getting repo info](https://docs.github.com/en/rest/repos/repos?apiVersion=2022-11-28#get-a-repository)
- useful command to get info about `peopledepot` project
``` bash
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

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.