hackforla / hackforla/311-data

DEV - Code and System Architecture FAQ

Open
#1,986 2 comments 0 reactions 0 assignees View on GitHub
Complexity: Small Feature: Documentation feature: FAQ ready for dev lead Role: Frontend size: 0.50pt
Dominant language
JavaScript
Stars
73
Forks
74
PR merge metrics
No merged PRs in 30d

Description

### Dependency
- [x] Waiting for new questions to be added.

### Overview

As developers who are trying to better understand the codebase, we need a place to post any questions about how the codebase works in FAQ format, as well as prepare these answers for future documentation (google docs, wiki).

### Table of Contents
- [🔴 Q: How Is Service Request Data Cleared in the Map](https://github.com/hackforla/311-data/issues/1986#issuecomment-2968403898)

### Action Items

Please complete the following action items for each question or answer.

Instructions For Submitting a Question

- [ ] Copy/Paste the FAQ Question Template text into a new comment, populate the generic fields...
- [ ] Question Title
- [ ] Context / Notes (if applicable)
- [ ] Modify _this issue_ ([#1986](https://github.com/hackforla/311-data/issues/1986))
- [ ] Move the ticket to Questions: https://github.com/orgs/hackforla/projects/63/views/1?filterQuery=Status%3AQuestions
- [ ] Remove the https://github.com/hackforla/311-data/labels/Dependency label
- [ ] Add the https://github.com/hackforla/311-data/labels/ready%20for%20dev%20lead label
- [ ] Edit the Table of Contents of _this ticket_ ([#1986](https://github.com/hackforla/311-data/issues/1986)
- [ ] Add a new bullet point, (see New Table of Contents Bullet Point Text (Copy/Paste))


Instructions For Answering a Question

- [ ] Click the Quote Reply and provide your response
- if you need more time to sufficiently answer the question...
- [ ] Move _this ticket_ ([#1986](https://github.com/hackforla/311-data/issues/1986)) to In Progress: https://github.com/orgs/hackforla/projects/63/views/1?filterQuery=Status%3A%22In+progress%22
- [ ] Provide an ETA and Availability
- [ ] Once your answer has been submitted...
- [ ] Assign this ticket to the volunteer who submitted the question
- [ ] Modify the Question comment's Answer Status to "Discussion In Progress" (see Allowable Statuses copy/paste)
- [ ] Edit the Table of Contents of _this ticket_ ([#1986](https://github.com/hackforla/311-data/issues/1986))
- [ ] Find the relevant Question comment, change the emoji-prefix from 🔴 to 🟡


Instructions For Finalizing an Answer

- [ ] Edit your Question comment with the following...
- [ ] Copy/Paste the relevant text from the Answer comment into the Selected Answer section
- [ ] Provide a link to the comment with the answer
- [ ] Update the "authored by" with the github-id of the volunteer who provided your answer
- [ ] Update the "Answered: YYYY-MM-DD" date
- [ ] Modify the Question comment's Answer Status to "Answered" (see Allowable Statuses copy/paste)
- [ ] Edit the Table of Contents of _this ticket_ ([#1986](https://github.com/hackforla/311-data/issues/1986))
- [ ] Find the relevant Question comment, change the emoji-prefix from 🟡 to 🟢
- [ ] If there are no further unanswered questions, modify _this ticket_ ([#1986](https://github.com/hackforla/311-data/issues/1986))...
- [ ] Clear the Assignee
- [ ] Move to the Icebox (on Hold): https://github.com/orgs/hackforla/projects/63/views/1?filterQuery=status%3A%22Icebox+%28on+hold%29%22, (see How to Change Project Board Status to Questions, but reverse it!)
- [ ] Remove the https://github.com/hackforla/311-data/labels/ready%20for%20dev%20lead and add the https://github.com/hackforla/311-data/labels/Dependency label


### Resources/Instructions

#### Useful Screenshots

How to Quote Reply

**Click on the ellipse, `...`, for the question you'd like to answer or discuss and select "Quote Reply".**

![Image](https://github.com/user-attachments/assets/8a0e014a-8d94-401b-965f-0127806fc389)


How to Change Project Board Status to Questions

**In the Sidebar (Right), click on the Status dropdown, and find the Questions option menu. Don't accidentally click on the right-most arrow, this will reveal nothing.**

![Image](https://github.com/user-attachments/assets/77f265c1-ca07-4688-a56c-dff405a50f56)


#### New Table of Contents Bullet Point Text (Copy/Paste)

```
- [🔴 Q: ](url-of-issue-comment)
```

#### FAQ Question Template Text (Copy/Paste)

```

## Q: [REPLACE-WITH-QUESTION]

### Context / Notes

Add any of your notes here, if applicable.

Consider using a dropdown if you have a lot of notes, or you want to include screenshots.

Dropdown Example

Like so...


### Selected Answer

n/a

---

Answered: YYYY-MM-DD
- [link-to-answer-issue-comment]
- authored by [@person-who-authored-answer]

#### Answer Status

🔴 Seeking Answer

```

#### Allowable Statuses (Copy/Paste)
```
🔴 Seeking Answer
```
```
🟡 Discussion In-Progress
```
```
🟢 Answered
```

#### Other Live-Forever Issues
- https://github.com/hackforla/311-data/issues/1878
- https://github.com/hackforla/311-data/issues/1726

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.