GreenInfo-Network / seattle-building-dashboard

Energy benchmarking for Seattle
https://greeninfo-network.github.io/seattle-building-dashboard/
ISC License
1 stars 0 forks source link

Process Documentation (SOW 2024 Task 3.5) #98

Open danrademacher opened 1 month ago

danrademacher commented 1 month ago

Looking at documentation, we have these overall buckets from SOW:

Provide written guidance (log-in info, procedure, screen shots) that will enable OSE users to implement data updates for:

  • The Intro.JS tutorial
  • Tabular data uploads in Carto
  • Property footprints

We have these existing documents:

  1. Uploading to CARTO: https://github.com/GreenInfo-Network/seattle-building-dashboard/blob/master/documentation/Update_building_energy_data.md. This could mainly use confirmation of completeness by someone who hasn't done it before/recently, and deleting the old instructions
  2. Updating footprints, https://github.com/GreenInfo-Network/seattle-building-dashboard/blob/master/documentation/Building_outlines.md. Note that this in turn relies on a Python script, https://github.com/GreenInfo-Network/seattle-building-dashboard/tree/master/documentation/scripts. (Interesting to imagine Mike Roos running this!). We will need to provide all the files that are referenced with P:\ server paths
  3. And then we have the Intro.js code here, https://github.com/GreenInfo-Network/seattle-building-dashboard/blob/master/src/app/views/layout/tutorial.js. Well commented but really not friendly for a non-developer.

This task and budget is pure documentation, so we are not on the hook to make this easy for Mike.

┆Issue is synchronized with this Asana task ┆Due Date: 2024-06-17