|
1 | | -# Clean & Green Philly Summer 2024 Roadmap |
| 1 | +## Clean & Green Philly 2025 Roadmap |
2 | 2 |
|
3 | | -## 🗓 Roadmap Overview |
| 3 | +### Overview |
4 | 4 |
|
5 | | -Welcome to the project roadmap for Clean & Green Philly! After launching v1.0.0 in spring of 2024, we will spend the summer shifting our focus from frontend tasks to building out a more robust data pipeline and a project CI/CD workflow. We will still continue to work on front end stuff, but will have a more balanced distribution across all parts of the project, while also gathering input through user research. |
| 5 | +Welcome to the project roadmap for Clean & Green Philly! This is a living document that serves to outline the scope of what we intend to work on in the coming year. We intend to make quarterly updates to this document as the year progresses. |
6 | 6 |
|
7 | | -## Front End |
| 7 | +We launched v1.0.0 of [cleanandgreenphilly.org](https://www.cleanandgreenphilly.org/) in the spring of 2024. Since then, we have made substantial updates to our data pipeline, incorporating parcel-level data for every property in Philadelphia, while undertaking several months of user research and workshops to understand where we want to go next. |
8 | 8 |
|
9 | | -### 🌐 Relevant Organizations Page |
| 9 | +In 2025, we plan to begin taking advantage of our new data pipeline to pursue new analytical possibilities, and to implement the necessary updates to the website that we’ve identified through the user research process. At a high level, this will entail: 1) rebranding to more clearly articulate our aims as an organization and avoid confusion with the Mayor’s Office of Clean & Green Initiatives; 2) rewriting site content to align with the rebrand, as well as adding improved contact and donations pages; 3) focusing our front-end development on improved web and mobile accessibility for the cleanandgreenphilly.org site, 4) streamlining our data pipeline and adding improved data quality controls, 5) establishing more robust CI/CD, 6) exploring the possibility of using machine learning to identify vacant properties. |
10 | 10 |
|
11 | | -- **Goal:** Create a page listing organizations actively working on related initiatives. |
12 | | -- **Key Actions:** |
13 | | - - Research and compile a list of relevant organizations. |
14 | | - - Design and develop the webpage to display this information in an accessible format. |
| 11 | +#### Organizational Rebrand 🎨 |
15 | 12 |
|
16 | | -### 📝 Grant Writing Opportunities |
| 13 | +**Goal:** The Executive Director will recruit pro bono support to help Clean & Green Philly rebrand based on our strategic plan, in order to clearly articulate our aims as an organization and how we are distinct from other initiatives (especially the Mayor’s Office of Clean and Green Initiatives). This Code for Philly team will support the integration of this rebrand into the website as needed, e.g., by updating site content, graphics, colors, etc. |
| 14 | +**Key Actions:** |
17 | 15 |
|
18 | | -- **Goal:** Provide a comprehensive list of grant writing opportunities for local organizations. |
19 | | -- **Key Actions:** |
20 | | - - Identify and list potential grant sources. |
21 | | - - Connect users to detailed grant writing resources and guides. |
| 16 | +- Recruit pro bono technical support for branding, marketing, graphic design, content writing. |
| 17 | +- Develop a branding kit with appropriate material for use in the newsletter, site, and elsewhere. |
| 18 | +- Communicate new branding guidelines for use on the website; update the site accordingly. |
22 | 19 |
|
23 | | -## Dataset Enhancements |
| 20 | +#### Content Rewrite ✍️ |
24 | 21 |
|
25 | | -### 🔢 Development Risk Indicator |
| 22 | +**Goal:** Following the organizational rebrand, the Executive Director will secure support in writing new site content to ensure alignment with our rebrand and strategic plan. Additionally, new material is needed for technical documentation (e.g., a data dictionary and clearer explanations of data points like our “priority level” designation) and the “Transform” page. |
| 23 | +**Key Actions:** |
26 | 24 |
|
27 | | -✅ **Completed June 2024** |
| 25 | +- Identify and draft needed technical documentation (note that this will require some concerted thought based on comparable examples and best practices); mock and implement actual UI. |
| 26 | +- Conduct user research and a comparative analysis to identify what content is missing on the website. |
| 27 | +- Survey domain experts to identify content missing from Get Access and Transform pages. |
| 28 | +- Recruit one or more content writers to update content for these pages. |
| 29 | +- Coordinate with the UX team on mocking and implementation. |
| 30 | +- Consider mocking and implementing/updating the following pages: |
| 31 | + - Contact |
| 32 | + - Donations |
| 33 | + - Grant opportunities for local organizations |
| 34 | + - A page listing organizations actively working on related initiatives |
28 | 35 |
|
29 | | -- **Goal:** Add a development risk metric based on building permits per census block. |
30 | | -- **Key Actions:** |
31 | | - - Calculate a z-scored count of building permits issued in the past year per census block. |
32 | | - - Scale the data from high to low, noting the approximation to avoid a false appearance of precision. |
| 36 | +#### Improving Web and Mobile Accessibility 📱 |
33 | 37 |
|
34 | | -### 📊 Tangled Titles Model |
| 38 | +**Goal:** In order to support less tech-saavy users, we will prioritize enhancements to web and mobile accessibility for cleanandgreenphilly.org. |
| 39 | +**Key Actions:** |
35 | 40 |
|
36 | | -- **Goal:** Develop a model to identify properties with tangled titles. |
37 | | -- **Key Actions:** |
38 | | - - Reach out to Pew about getting their dataste on tangled titles. |
39 | | - - Build and implement a predictive model to identify potential tangled titles in our dataset dataset. |
| 41 | +- Build on the user journeys mapped out in the 2024 community workshop slides, adding these to the website to help guide new users. |
| 42 | +- Create a tutorial for the “Find Properties” page using the [React Joyride guided tours package](https://github.com/gilbarbara/react-joyride). |
| 43 | +- Implement fixes to pain points as identified by the UX team in our user workshops. |
| 44 | +- Consider adding an “FAQ” page to the site, if needed. |
40 | 45 |
|
41 | | -### 🏗 Negligent Developers Data |
| 46 | +#### Enhancing Data Pipeline ⚙️ |
42 | 47 |
|
43 | | -✅ **Completed June 2024** |
| 48 | +**Goal:** Improve the maintainability and functionality of the data pipeline by improving code quality and adding better data quality control checks. |
| 49 | +**Key Actions:** |
44 | 50 |
|
45 | | -- **Goal:** Include data on negligent developers in our dataset. |
46 | | -- **Key Actions:** |
47 | | - - Define what constitutes negligent development. |
48 | | - - Implement a workflow to identify likely cases of negligent developers in our dataset. |
| 51 | +- Refactor the data pipeline to improve the maintainability of the codebase (considering using tools like `vulture` and `radon` for this purpose). |
| 52 | + - Relatedly: |
| 53 | + - https://github.com/CodeForPhilly/clean-and-green-philly/issues/717 |
| 54 | + - https://github.com/CodeForPhilly/clean-and-green-philly/issues/706 |
| 55 | +- Add formal, consistent data quality controls using libraries like `dbt`, rather than our current ad hoc checks that exist in the pipeline. |
49 | 56 |
|
50 | | -## Back-End |
| 57 | +#### Improving CI/CD 🚀 |
51 | 58 |
|
52 | | -### 📦 Containerization |
| 59 | +**Goal:** Improve our CI/CD process to reduce the workload on project leads and ensure the maintainability of the codebase. |
| 60 | +**Key Actions:** |
53 | 61 |
|
54 | | -- **Goal:** Containerize the entire backend setup to improve deployment efficiency and allow for migration to Google Cloud Services (GCS). |
55 | | -- **Key Actions:** |
56 | | - - Build out a Dockerfile to run the entire ETL pipeline in the cloud. |
57 | | - - Deploy the container to GCS. |
| 62 | +- Add tests for key parts of the data pipeline, using a sample dataset stored on GitHub, or mocking data when necessary. |
| 63 | +- Ensure that tests are integrated into the GitHub Actions workflows to prevent breaking code from being added to the codebase. |
| 64 | + - Along the way, address: https://github.com/CodeForPhilly/clean-and-green-philly/issues/830 |
| 65 | +- Eliminate redundant GitHub Actions workflows while also making sure that the remaining ones all function as intended. |
| 66 | +- Review documentation to ensure that it is up to date and accurate. |
58 | 67 |
|
59 | | -### ☁️ Porting to Google Cloud |
| 68 | +#### Exploring ML 🧠 |
60 | 69 |
|
61 | | -- **Goal:** Migrate our pipeline to Google Cloud. |
62 | | -- **Key Actions:** |
63 | | - - Automate data updates with scheduled cloud functions to refresh our dataset monthly. |
64 | | - - Document migration steps and best practices for future reference. |
| 70 | +**Goal:** Explore the possibility of using ML with our dataset to identify vacant properties. |
| 71 | +**Key Actions:** |
65 | 72 |
|
66 | | -### 🧪 Implementing Data Quality Tests |
67 | | - |
68 | | -- **Goal:** Implement data quality assurance measures using tools like `dbt`. |
69 | | -- **Key Actions:** |
70 | | - - Define data quality metrics and tests. |
71 | | - - Integrate `dbt` into our data processing pipelines. |
72 | | - - Schedule and monitor data quality checks to ensure continuous data integrity. |
73 | | - |
74 | | -### 🔄 Setting Up CI/CD |
75 | | - |
76 | | -- **Goal:** Establish a Continuous Integration/Continuous Deployment (CI/CD) workflow to streamline development and deployment. |
77 | | -- **Key Actions:** |
78 | | - - Develop CI/CD pipelines using GitHub Actions including automated testing, building, and deployment. |
79 | | - |
80 | | -### 📧 Automated Stakeholder Communication |
81 | | - |
82 | | -- **Goal:** Automate the process of sending targeted email updates to stakeholders such as Habitat for Humanity about new, eligible properties. |
83 | | -- **Key Actions:** |
84 | | - - Set up email triggers in our system to send out monthly updates. |
85 | | - - Customize email content based on stakeholder interest and relevance. |
| 73 | +- Perform EDA to identify key features in the dataset associated with vacancy indicators. |
| 74 | +- Explore basic modeling approaches (e.g., logit, RF) as proofs of concept to demonstrate the viability of using ML to identify vacant properties. |
| 75 | +- Work with key stakeholders to identify scalable ways to supplant the City’s outdated vacancy by building our own model. |
0 commit comments