Epic: Documentation and Wiki

[ryanfchase]

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.

• A1: Comparison of Hack for LA Wikis #1874
• A2: PRD - Propose and Format new structure for 311 Wiki #1875
• A3: PRD - Review Wiki and determine if they belong in the Home or Sidebar #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.

• B0: UXR: Summarize and Document UXR Google Drive folder structure #1849
• B1: UXR Spike: Comparison of Hack for LA Wikis #1850
• B2: UXR: Content Audit for 311 Data Research Wiki #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
• C3: Decision Record: Upgrading to Vite from Webpack #1829
• C4: DEV - Write documentation requiring React components to have .jsx extension instead of .js #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 - 311 Data Weekly Meeting Agenda #1545 (comment)
• C11: Page for Client/Server architecture (Old Tech Stack): 311-Data System Architecture

---

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.

• D1: PM Spike: Learn and report on website team's usage of DRs #1842
• D2: PM: Create Decision Record Wiki Page #1830
• D3: PM: Create Emergent Requirement Wiki + Template #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, credit to @kiranofans)
• How to modify the Contact Us form on the 311-data@hackforla.org drive: 1780 complete contact form functionality #1792
• Instructions for onboarding new 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
   2.02. 311-Data Wiki
   2.03. All Epics
   2.04. How to create an issue (from website team but very applicable)

Quick links

• Wiki

[ExperimentsInHonesty]

Tracy wants us to look at 311-Data: Project Documentation #1863 as it relates to section C5 -C9

Recorded to the cloud Tracys KT comments on 2025-02-15 11:48 - 11:53 zoom 1