hackforla / hackforla/311-data

Epic: Documentation and Wiki

Open
#1,796 1 comment 0 reactions 4 assignees Assigned to @rayneng View on GitHub
Complexity: Small Epic Feature: Documentation feature: guide Role: Frontend Role: Product Management role: UI/UX Design role: UI/UX Research size: 0.25pt
Dominant language
JavaScript
Stars
73
Forks
74
PR merge metrics
No merged PRs in 30d

Description

### Overview

We need to update our Wiki so that it effectively communicates the 311-Data project's current progress, as well as the decisions that led to the systems and frameworks that we now use.

### Action Items

Section A: HfLA Wiki Conformance, Product Maintenance

Instructions

Prepare team's public resources for launch
- Labels: `Role: Product Management`, `Feature: Documentation`, `Size: Missing`, `Complexity: Missing`
- Milestone: `06 - Product Maintenance`
- Projects: `P: 311: Project Board`

Please turn the following into tickets with the above ticket criteria. Check the box when the ticket has been created, replace the checkbox's text with a link to the newly created ticket.


- [x] A1: https://github.com/hackforla/311-data/issues/1874
- [x] A2: https://github.com/hackforla/311-data/issues/1875
- [x] A3: #1841

---

Section B: UX Research and Research Ops

Instructions

Prepare UXR's public resources for launch
- Labels: `Role: UI/UX Research`, `Feature: Documentation`, `Size: Missing`, `Complexity: Missing`
- Milestone: `06 - Product Maintenance`
- Projects: `P: 311: Project Board`

Please turn the following into tickets with the above ticket criteria. Check the box when the ticket has been created, replace the checkbox's text with a link to the newly created ticket.


- [x] B0: https://github.com/hackforla/311-data/issues/1849
- [x] B1: https://github.com/hackforla/311-data/issues/1850
- [x] B2: https://github.com/hackforla/311-data/issues/1876

---

Section C: Dev, Data, and Dev Ops

Instructions

Prepare to share technical information with new devs, communities of practice, external groups.
- Labels: `Role: Frontend`, `Feature: Documentation`, `Size: Missing`, `Complexity: Missing`
- Milestone: `06 - Product Maintenance`
- Projects: `P: 311: Project Board`

Please turn the following into tickets with the above ticket criteria. Check the box when the ticket has been created, replace the checkbox's text with a link to the newly created ticket.


- [ ] C1: Decision Record: Adopting the Frontend-Only architecture.
- [ ] C2: Update contributing.md to match hfla site
- [x] C3: https://github.com/hackforla/311-data/issues/1829
- [x] C4: https://github.com/hackforla/311-data/issues/1823
- [ ] C5: Front-end: Mapbox integrations, Main react components, Utils, Userflow definition.
- [ ] C6: Backend: Data source, dbProvider, What is: Data load into Mapbox integrations.
- [ ] C7: DevOps: Developer CI, Testing, Deployment Branching strategies, automation w/Github Actions.
- [ ] C8: Data: Data pipeline, Infrastructure for Analysis models.
- [ ] C9: DevEx: Onboarding, Standardization (Linting, Formatting, Type Check), Branching strategy.
- [ ] C10: High level tech stack breakdown - https://github.com/hackforla/311-data/issues/1545#issuecomment-2303573038
- [ ] C11: Page for Client/Server architecture (Old Tech Stack): [311-Data System Architecture](https://docs.google.com/document/d/1hgJyxs45aZv1mVOPnbBm783KBiHVjI0zWIX1jOxz-3s/edit?pli=1#heading=h.tqyocgo4qd86)

---

Section D: Decision Record Infrastructure, Project Maintenance

Instructions

Create infrastructure for documenting team decisions and requests from volunteers
- Labels: `Role: Product Management`, `Feature: Documentation`, `Size: Missing`, `Complexity: Missing`
- Milestone: `03 - Product Management`
- Projects: `P: 311: Project Board`

Please turn the following into tickets with the above ticket criteria. Check the box when the ticket has been created, replace the checkbox's text with a link to the newly created ticket.


- [X] D1: https://github.com/hackforla/311-data/issues/1842
- [x] D2: https://github.com/hackforla/311-data/issues/1830
- [ ] D3: https://github.com/hackforla/311-data/issues/1831

---

### Possible Emergent Requests
- [ ] DR: Removing City Council feature layer from our codebase
- [ ] Accountability Checks
- [ ] Accessing assets on Figma as a designer (see [this comment](https://github.com/hackforla/311-data/issues/1785#issuecomment-2303172946), credit to @kiranofans)
- [ ] How to modify the Contact Us form on the `311-data@hackforla.org` drive: https://github.com/hackforla/311-data/pull/1792
- [X] [Instructions for onboarding new devs](https://github.com/hackforla/311-data/wiki/Instructions-For-Onboarding-Devs)
- [ ] https://masteringmarkdown.com/

### Resources/Instructions
1. Important features of Wiki pages, Screenshots

1.01 Screenshot of Pages table of contents dropdown

todo


1.02 Screenshot of Sidebar with edit button

todo


2. Useful Links
2.01. [311-Data.org shared drive](https://drive.google.com/drive/folders/1ObUz4mTQmSCwND_WQcOXAuCeKpCwNzmz?usp=sharing)
2.02. [311-Data Wiki](https://github.com/hackforla/311-data/wiki)
2.03. [All Epics](https://github.com/hackforla/311-data/issues?q=is%3Aissue+is%3Aopen+label%3AEpic+)
2.04. [How to create an issue](https://github.com/hackforla/website/wiki/How-to-create-issues) (from website team but very applicable)

Quick links
- [Wiki](https://github.com/hackforla/311-data/wiki)

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.