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

Improve transit database documentation #3774

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

evansiroky
Copy link
Member

Description

Following internal discussion, this update tries to add more documentation about the core data model of "organizations", "services", "gtfs service data" and "gtfs datasets".

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?

Hoping the CI runs pass. 🙏

Post-merge follow-ups

  • No action required
  • Actions required (specified below)

Copy link

@@ -6,8 +6,12 @@ Inconsistent use of the term `agency` can be confusing, so this section of the d

| <span style="white-space: nowrap;">Area of Focus</span> | How to Identify an `agency` |
| ------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Organizations** | Within the [California Transit Base](california-transit), organizations can represent transit agencies or other organizations that don't provide transit service. Some of these entities may "manage" several transit services. Some of these organizations have a built-in crosswalk to NTD data via the `ntd_id_2022` column. |
| **Services** | Within the [California Transit Base](california-transit), services represent a type of transit "product" that people can use to travel. Services are differentiated if there is a difference in any of the following characteristics: <ol><li>Provider of the service</li><li>"Super-mode" of the service.</li><li>Whether the service is a "fixed-route" service.</li><li>Whether there are different "rider requirements" that passengers must qualify for in order to ride.</li></ol> Often times, organizations (especially large transit agencies) will "manage" multiple services. <br/><br/>**Examples of `services` for OCTA:**<br/><ul><li>`Orange County Transportation Authority`: fixed-route bus service</li><li>`OC Streetcar`: fixed-route streetcar service</li><li>`OC ACCESS`: paratransit demand-response service</li><li>`OC Flex`: a demand-response service open to public</li></ul>|
Copy link
Contributor

Choose a reason for hiding this comment

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

Can you define what super mode means in this context?

@@ -6,8 +6,12 @@ Inconsistent use of the term `agency` can be confusing, so this section of the d

| <span style="white-space: nowrap;">Area of Focus</span> | How to Identify an `agency` |
| ------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Organizations** | Within the [California Transit Base](california-transit), organizations can represent transit agencies or other organizations that don't provide transit service. Some of these entities may "manage" several transit services. Some of these organizations have a built-in crosswalk to NTD data via the `ntd_id_2022` column. |
Copy link
Contributor

Choose a reason for hiding this comment

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

Can you give an example of an entity that manages several transit services and an example of an organization that doesn't provide transit service?

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.

2 participants