Skip to content

Commit

Permalink
docs: update data manager pages
Browse files Browse the repository at this point in the history
  • Loading branch information
AdrianaCeric committed Sep 15, 2023
1 parent f90427a commit 9c749b4
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 34 deletions.
14 changes: 5 additions & 9 deletions docs/user/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@

## Conceptual Overview

The GTFS Data Manager enables exchange and coordination of data creation, updates, validation and deployment of GTFS data feeds for transit schedules.
The GTFS Data Manager makes the creation, updates, validation and deployment of GTFS data feeds easier.

The platform allows GTFS producers (transit operators, local governments, etc.) to share existing feeds or utilize the build function in GTFS Editor to create and maintain feeds. GTFS creators can use the built in validator to check for potential issues.
GTFS producers (transit operators, local governments, etc.) can share existing feeds or use the build function in GTFS Editor to create and maintain feeds. GTFS creators can use the built in validator to check for potential issues.

## Data Manager Concepts

Expand All @@ -16,9 +16,9 @@ Projects are collections of feed sources and deployments.

Feed sources define the locations or upstream sources of GTFS feeds. These can be any combination of feeds that are:

1. **Manually Uploaded** - Manually collected/managed feeds provided directly by an external source.
2. **Fetched Automatically** - Public available feeds that can be fetched from a URL
3. **Produced In House** - Internally managed/created feeds produced by GTFS Editor
1. **Manually Uploaded**: Manually collected/managed feeds provided directly by an external source.
2. **Fetched Automatically**: Public available feeds that can be fetched from a URL.
3. **Produced In House**: Internally managed/created feeds produced by GTFS Editor.

### Feed Versions

Expand All @@ -27,7 +27,3 @@ Feed Versions store specific instances of a GTFS feed for a given feed source as
### Snapshots

Internally managed GTFS data sets are pulled from the GTFS Editor using “snapshots” created in the editor interface. These snapshots are static versions of the data set, that serve as save points that can be exported or used as starting point for future edits. The Data Manager only imports versions of feeds where a snapshot has been created. This allows users to ensure the correct version of data is being imported and to retrieve and review data in the future.



*Note: See section 2.6 in GTFS Editor User Manual for more information on snapshots.*
53 changes: 28 additions & 25 deletions docs/user/managing-projects-feeds.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,40 +4,43 @@

Projects are created from the main Project listing page. Click the `Create Project` button to create a new Project; a row for the new Project will appear in the table. Type a name and click the check button (or hit Enter/Return) to finish creating the Project.

![screen capture](../gif/create-project.gif)
create-project IMAGE HERE

## Managing Projects

Clicking on a project in the main project listing will take you to the detailed project profile page:
Clicking on a project in the main project listing will take you to the detailed project profile page.

![screenshot](../gif/project-profile.gif)
The **Settings** tab can be expanded to reveal optional properties that can be specified for the project. These include the location of the project's geographic coverage area (specified either as a single coordinate or a rectangular region) and the default time zone. These values, when provided, are used to populate the corresponding feed-level properties when creating new feeds within this project.

At the top of the page is the **Project Settings** panel which can be expanded to reveal optional properties that can be specified for the project. These include the location of the project's geographic coverage area (specified either as a single coordinate or a rectangular region) and the default time zone. These values, when provided, are used to populate the corresponding feed-level properties when creating new feeds within this project.
project-settings IMAGE HERE
## Creating a Feed Source

To the left of the Project Settings panel is the **Feed Sources** panel. Feed Sources are the core of a project, and are documented in more detail below. Likewise the **Deployments** panel will be covered in more detail later in the documentation.
To the left of the Project Settings panel is the **Feed Sources** panel. Feed Sources are the core of a project, and are documented in more detail below.

## Creating a Feed Source
project-feed-sources IMAGE HERE

Feed Sources are created from a Project's main profile page. Click the `+New` button from the `Actions` dropdown to create a new feed; Specify a name and optional feed source URL and click "Save". You may also adjust whether to automatically fetch the feed from the source URL and to make the feed deployable.

create-feed-source IMAGE HERE

## Managing Feed Sources

After a Feed Source has been created, it will appear in the Project's table of Feed Sources. From this table, a basic summary of information for the feed is presented (including if the latest version has expired and how many validation issues it has).

To access the Feed Source Profile for this feed, click on its name.

![screenshot](../gif/feed-profile.gif)
fee-profile IMAGE HERE

At the top of the page is a set of tabs, which include:

- **GTFS** - main point of entry for Feed Source
- **GTFS**: Main point of entry for Feed Source which includes:
- Feed Version Navigator (covered in more detail below)
- Feed Version Summary - view feed info and discover information about routes, patterns and stops
- Validation issues - view and filter list of validation issues
- Version comments - leave and view comments specific to a Feed Version
- **Snapshots** - list of Editor snapshots (or save points)
- **Notes** - where users can leave and view comments specific to this Feed Source
- **Settings** - access to Feed Source settings
- **Snapshots**: List of Editor snapshots (or save points)
- **Notes**: A place to leave and view comments specific to this Feed Source
- **Settings**: Access to Feed Source settings
- Editing basic Feed Source properties such as name, fetch URL, and public visibility
- Viewing/editing settings provided by custom extensions
- Deleting a Feed Source (for users with sufficient permissions) in the **Danger zone** properties.
Expand All @@ -56,42 +59,42 @@ Feed Versions are created from the main Feed Source profile page. There are thre

5. **Regional Merge**: For Projects that contain multiple Feed Sources across a region, it can be useful to merge multiple transit agencies together into a combined GTFS feed for the entire region. While viewing a Project's list of Feed Sources, click `Actions > Merge all` to produce a combined GTFS file for all Feed Sources.

**Note:** when uploading or fetching a feed, and the file being uploaded or fetched is not different from the latest version, no new Feed Version will be created.
**Note**: when uploading or fetching a feed, and the file being uploaded or fetched is not different from the latest version, no new Feed Version will be created.

## Feed Transformations

Data Tools now supports **Feed Transformations**, which can apply a set of changes automatically to each new GTFS feed loaded into the system. This is especially helpful for applying repeatable changes to or inserting supplementary files into GTFS feeds that need to be enhanced. It provides a critical stopgap to improve GTFS coming out of systems that cannot be modified (e.g., scheduling software that has a rigid export format). The different transformation types currently supported are:
Data Tools now support **Feed Transformations**, which can automatically apply a set of changes to each new GTFS feed loaded into the system. This feature is especially useful for applying repeatable changes to, or inserting supplementary files into, GTFS feeds that require enhancement. It serves as a critical stopgap for improving GTFS data from systems that cannot be modified, such as scheduling software with a rigid export format. The currently supported transformation types are:

1. **Replace File From Version** - any file in an incoming GTFS (e.g., feed_info.txt) can be overwritten or inserted with a file extracted from a previously loaded feed version.
1. **Replace File From Version** - any file in an incoming GTFS (e.g., `feed_info.txt`) can be overwritten or inserted with a file extracted from a previously loaded feed version.

2. **Replace File From String** - any file in an incoming GTFS (e.g., feed_info.txt) can be overwritten or inserted with user-defined CSV data.
2. **Replace File From String** - any file in an incoming GTFS (e.g., `feed_info.txt`) can be overwritten or inserted with user-defined CSV data.

### Configuring Feed Transformations

Follow the steps below to configure Feed Transformations for an existing Feed Source:

1. Select a Feed Source and click `Settings > Feed Transformations`.
2. From here, click `Add transformation` to begin creating a new set of rules for incoming GTFS feeds. Your first ruleset will automatically apply to GTFS that is fetched automatically *and* manually uploaded, but this can be changed for each ruleset to apply to any of the retrieval methods listed in [Creating Feed Versions](#creating-feed-versions).
3. Click `Add step to transformation` to select a transformation type and fill in the required fields for each type. Multiple transformations can be specified and each will be applied to the incoming GTFS file in the order that they are defined.
1. Select a Feed Source and click on `Settings > Feed Transformations`.
2. From here, click on `Add transformation` to begin creating a new set of rules for incoming GTFS feeds. Your first ruleset will automatically apply to GTFS that is fetched automatically and manually uploaded, but this can be changed for each ruleset to apply to any of the retrieval methods listed in [Creating Feed Versions](#creating-feed-versions).
3. Click on `Add step to transformation` to select a transformation type and fill in the required fields for each type. Multiple transformations can be specified, and each will be applied to the incoming GTFS file in the order in which they are defined.

![screenshot](../img/configure-feed-transformations.png)
configure-feed-transformations IMAGE HERE

### Viewing the Feed Transformation Summary

Once the Feed Transformations have all been configured, you can import a new GTFS file using one of the retrieval methods you have specified for your ruleset. Once the GTFS file has been processed, a summary of the transformations is available by hovering over the wrench icon that is visible in the Feed Version panel.
After configuring all the Feed Transformations, you can import a new GTFS file using one of the retrieval methods you specified for your ruleset. Once the GTFS file has been processed, a summary of the transformations is accessible by hovering over the wrench icon visible in the Feed Version panel.

![screenshot](../img/feed-transformation-summary.png)

A more in depth summary is available under the Transformation Results tab on the left sidebar. This panel will show you the modifications made to each file in the feed, along with how many rows were added, deleted, or modified.

## Viewing and Managing Feed Versions

The Feed Version navigator allows you to navigate through all available versions of a given feed using the `` and `` buttons (or view a list of all versions). You can also use this interface to:
The Feed Version navigator enables you to browse through all available versions of a given feed using the `` and `` buttons (or view a list of all versions). You can also use this interface to:

- download a Feed Version to your local machine as a GTFS data file,
- load a version into the Editor, and
- delete a Feed Version from the Data Manager. (Note: deleting a Feed Version cannot be undone.)
- Download a Feed Version to your local machine as a GTFS data file.
- Load a version into the Editor.
- Delete a Feed Version from the Data Manager. (Note: Deleting a Feed Version cannot be undone.)

![screenshot](../img/feed-version-navigator.png)

To the left of the navigator is a list of views available for to the currently active version. These include basic feed statistics, the detailed feed validation report, and any user comments specific to this feed.
To the left of the navigator is a list of views available for the currently active version. These views include basic feed statistics, the detailed feed validation report, and any user comments specific to this feed.

0 comments on commit 9c749b4

Please sign in to comment.