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

Short term counting program documentation needs an overhaul #1029

Open
Nate-Wessel opened this issue Aug 2, 2024 · 2 comments · May be fixed by #1077
Open

Short term counting program documentation needs an overhaul #1029

Nate-Wessel opened this issue Aug 2, 2024 · 2 comments · May be fixed by #1077
Assignees
Labels
Documentation MOVE For stats linked to MOVE

Comments

@Nate-Wessel
Copy link
Contributor

I keep getting totally turned around in this readme and am having some have real trouble figuring out some pretty basic things. Some top level issues:

  • There's really no overview of the program or the different types of counts. The documentation launches straight into the details. There's no way to start at a general level and navigate my way to any specifics I may be looking for.
  • The table names are awful. While they probably can't be changed in the near term, they definitely shouldn't be used as section headings without any other contextualization.
  • There doesn't seem to be any consideration of who this document is for. For data-ops Airflow users? For people trying to complete data requests? Etc?
  • I can't figure out how to answer basic questions like "I want the TMCs within X area"

I'd love to see this revamped in the style of the docs we have now for Miovision.

Or does this exist somewhere else and I'm just looking in the wrong place?

@radumas
Copy link
Member

radumas commented Aug 6, 2024

This documentation has not kept pace with (new) transformations getting transferred over with the replicator, as well as changes to the data with the changing count contract.

The MOVE team have been documenting tables with comments, which are getting replicated over to the traffic schema. But this is insufficient as an entry point to getting an overview of the data.

The data pipeline is the partial responsibility of three different teams, and there's going to be a discussion of whose responsibility it is to overhaul this set of documentation pages.

@gabrielwol gabrielwol added the MOVE For stats linked to MOVE label Aug 6, 2024
@mkewins mkewins self-assigned this Aug 7, 2024
@mkewins
Copy link
Contributor

mkewins commented Aug 7, 2024

I can take a first stab at this. @peter-lyons and I recently went through all the replicated tables and made sure they're all commented in the database docs. I can transfer that knowledge -- and higher level knowledge -- over to this space.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation MOVE For stats linked to MOVE
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants