Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

System Architecture Documentation #1863

Open
7 tasks
traycn opened this issue Nov 21, 2024 · 1 comment
Open
7 tasks

System Architecture Documentation #1863

traycn opened this issue Nov 21, 2024 · 1 comment
Assignees
Labels
Feature: Missing Milestone: X - Technical Debt Role: Backend Related to API or other server-side work Role: Data Science Data management, loading, or analysis Role: DevOps infrastructure, CI or related work Role: Frontend React front end work Size: 3pt Can be done in 13-18 hours

Comments

@traycn
Copy link
Member

traycn commented Nov 21, 2024

Overview

We need to write up-to-date System Architecture documentation to describe to applications architecture at a high level and document the central understanding of the projects current state.

Action Items

  • Front-end: Mapbox integrations, Main react components, Utils, Userflow definition.
  • Backend: Data source, dbProvider, What is: Data load into Mapbox integrations.
  • DevOps: Developer CI, Testing, Deployment Branching strategies.
  • Data: Data pipeline, Infrastructure for Analysis models.
  • DevEx: Onboarding, Standardization (Linting, Formatting, Type Check), Branching strategy.
  • Visuals, Provide diagrams as is helpful.
  • Best Practices across SDLC.

Resources/Instructions

Document360 article -2024
Lucidchart article

@traycn traycn added Role: Frontend React front end work Role: Backend Related to API or other server-side work Role: Data Science Data management, loading, or analysis Size: 3pt Can be done in 13-18 hours Role: DevOps infrastructure, CI or related work Milestone: X - Technical Debt labels Nov 21, 2024
@traycn traycn self-assigned this Nov 21, 2024
@github-project-automation github-project-automation bot moved this to New Issue Approval in P: 311: Project Board Nov 21, 2024
@traycn
Copy link
Member Author

traycn commented Nov 22, 2024

ETA: Friday 11/22 @ 12PM

Update:
Sunday 11/24 @ 12PM
-Adding additional resources/improvements based on PM meeting discussion of 311-data's vision.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Feature: Missing Milestone: X - Technical Debt Role: Backend Related to API or other server-side work Role: Data Science Data management, loading, or analysis Role: DevOps infrastructure, CI or related work Role: Frontend React front end work Size: 3pt Can be done in 13-18 hours
Projects
Status: New Issue Approval
Development

No branches or pull requests

3 participants