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.

Sign up for GitHub

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

Jump to bottom

Schema documentation #37

Open
lgloege opened this issue Oct 6, 2022 · 4 comments
Open

Schema documentation #37

lgloege opened this issue Oct 6, 2022 · 4 comments

Comments

@lgloege
Copy link

lgloege commented Oct 6, 2022

We should think about how to document the schema so it is clear:

  • what each column represents
  • the format being used, especially since the IDs are not auto-generated
  • the units we are using. For example, making it clear all emissions are reported in metric tonnes

We should also discuss how to disseminate the documentation. I propose creating a Read The Docs or mdBooks site
@evanp
Copy link
Contributor

evanp commented Oct 6, 2022

Can we just use comments in the SQL for now?

@lgloege
Copy link
Author

lgloege commented Oct 6, 2022

Sounds good. I agree commenting the SQL is a good place to start

@lgloege
Copy link
Author

lgloege commented Oct 7, 2022

created a documentation branch to start this effort

@yeozy95
Copy link

yeozy95 commented Oct 13, 2022

@lgloege let me know if any input is required from me for this - TIA!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@evanp @yeozy95 @lgloege