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

Docs Sweep - Discoverability, Philosophy, and Sentry Guidance #3331

Merged
merged 28 commits into from
Apr 23, 2024

Conversation

SorenSpicknall
Copy link
Contributor

Description

Resolves #3128, #3316, and #3317 through a wave of docs updates and additions. Makes essential information about how we build pipelines and infrastructure more discoverable using the Cal-ITP docs site as a starting point, adds narrative text about the why behind many of our pipeline practices, and updates various already-extant resources to be more approachable, more interconnected, and more relevant to the current state of the ecosystem.

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation

How has this been tested?

Docs built in CI

Post-merge follow-ups

  • No action required
  • Actions required (specified below)

Copy link

Copy link
Member

@charlie-costanzo charlie-costanzo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you so much for taking care of this @SorenSpicknall, this is immensely helpful


To determine the best storage location for your raw data (especially if it requires manual curation), consult the [Data Collection and Storage Guidance within the Cal-ITP Data Pipeline Google Doc](https://docs.google.com/document/d/1-l6c99UUZ0o3Ln9S_CAt7iitGHvriewWhKDftESE2Dw/edit).
To determine the most appropriate ingest approach and storage location for your raw data (especially if that data requires manual curation), consult the [Data Collection and Storage Guidance within the Cal-ITP Data Pipeline Google Doc](https://docs.google.com/document/d/1-l6c99UUZ0o3Ln9S_CAt7iitGHvriewWhKDftESE2Dw/edit).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

wondering if this google doc should be put into the calitp docs site

@SorenSpicknall SorenSpicknall merged commit c0829bf into main Apr 23, 2024
2 checks passed
@SorenSpicknall SorenSpicknall deleted the soren-docs_sweep branch April 23, 2024 14:11
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

Successfully merging this pull request may close these issues.

Document data infra design philosophy
2 participants