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

collect list of important documents from the season #1

Open
karenng-civicsoftware opened this issue Oct 13, 2019 · 2 comments
Open
Assignees

Comments

@karenng-civicsoftware
Copy link

karenng-civicsoftware commented Oct 13, 2019

Please add documents that you would like to appear in the Civic documentation library here.

@karenng-civicsoftware
Copy link
Author

karenng-civicsoftware commented Oct 13, 2019

Data science & analysis guidelines

  • guidelines to get data scientists and analysts started : data flow guidelines for creating story cards & analyses link

Story card-specific docs

we may want to consolidate the docs below

  • quick start guide for story card by @smooto link
  • documentation template for each story card link
  • story card content template (google version) link
  • story card content task list (github version) link
  • guidelines to make content edits to story cards link

Data engineering

  • onboarding data with metadata link to metadata doc form
  • Tutorial: How to load GIS data into postgres by @znmeb link
  • perhaps we should add some "best practice" guide for organizing data in the RDS?

Backend

  • Backend template repo README link
  • Swagger API docs link
  • should we add a guide about setting up & maintaining our data storage services, e.g. RDS / S3?

Infra

  • README doc from infra repo link

Front end

  • @Dianna should people refer to the README for front end guidelines?

Data visualization

  • data vis. guidelines link

  • description of storybook & our data viz framework: is the link here sufficient?

Sandbox guidelines

@karenng-civicsoftware karenng-civicsoftware self-assigned this Oct 13, 2019
@karenng-civicsoftware
Copy link
Author

Adding the draft of data governance / engineering policies https://docs.google.com/document/d/1V59RcRNc-s0YJcXydCvyaqovIXvJ9LzTg9TJra_S7T4/edit#

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

No branches or pull requests

1 participant