Skip to content

Commit

Permalink
Fixed navigation config (#318)
Browse files Browse the repository at this point in the history 
* Squashed commit of the following:

commit fe496d1
Author: isabelle-dr <[email protected]>
Date:   Tue Feb 6 14:29:31 2024 -0500

    Removing translations (#306)

    * dummy commit

    * Remove translations part one

    * removing translations

    * Make changes based on review

* Squashed commit of the following:

commit 30ce1ef
Author: Sergio Delgado Rodriguez <[email protected]>
Date:   Tue Feb 6 15:46:57 2024 -0500

    new_GTFS.org_structure (#307)

    Adding new files for new GTFS architecture. This change does not remove the old files.

commit fe496d1
Author: isabelle-dr <[email protected]>
Date:   Tue Feb 6 14:29:31 2024 -0500

    Removing translations (#306)

    * dummy commit

    * Remove translations part one

    * removing translations

    * Make changes based on review

* Moved content to Getting started section

* Added examples page to Getting started

* Update publishing page in Getting started

* Squashed commit of the following:

commit 02d6e1f
Author: Fabien Richard-Allouard <[email protected]>
Date:   Tue Feb 6 16:52:12 2024 -0500

    Moved content to Getting started section (#309)

    * Squashed commit of the following:

    commit fe496d1
    Author: isabelle-dr <[email protected]>
    Date:   Tue Feb 6 14:29:31 2024 -0500

        Removing translations (#306)

        * dummy commit

        * Remove translations part one

        * removing translations

        * Make changes based on review

    * Squashed commit of the following:

    commit 30ce1ef
    Author: Sergio Delgado Rodriguez <[email protected]>
    Date:   Tue Feb 6 15:46:57 2024 -0500

        new_GTFS.org_structure (#307)

        Adding new files for new GTFS architecture. This change does not remove the old files.

    commit fe496d1
    Author: isabelle-dr <[email protected]>
    Date:   Tue Feb 6 14:29:31 2024 -0500

        Removing translations (#306)

        * dummy commit

        * Remove translations part one

        * removing translations

        * Make changes based on review

    * Moved content to Getting started section

    * Added examples page to Getting started

    * Update publishing page in Getting started

commit 72995c0
Author: Tzu-Jen Chan <[email protected]>
Date:   Tue Feb 6 16:37:08 2024 -0500

    [Design Sprint] Add content for documentation landing page (#308)

    * Squashed commit of the following:

    commit 30ce1ef
    Author: Sergio Delgado Rodriguez <[email protected]>
    Date:   Tue Feb 6 15:46:57 2024 -0500

        new_GTFS.org_structure (#307)

        Adding new files for new GTFS architecture. This change does not remove the old files.

    commit fe496d1
    Author: isabelle-dr <[email protected]>
    Date:   Tue Feb 6 14:29:31 2024 -0500

        Removing translations (#306)

        * dummy commit

        * Remove translations part one

        * removing translations

        * Make changes based on review

    * Add content for spec landing page

    * Remove pencil link and add links to spec

* Squashed commit of the following:

commit edef886
Author: Elias Gino Cripotos <[email protected]>
Date:   Tue Feb 6 17:11:49 2024 -0500

    Changes to Community Section (#311)

    * Squashed commit of the following:

    commit fe496d1
    Author: isabelle-dr <[email protected]>
    Date:   Tue Feb 6 14:29:31 2024 -0500

        Removing translations (#306)

        * dummy commit

        * Remove translations part one

        * removing translations

        * Make changes based on review

    * Squashed commit of the following:

    commit 30ce1ef
    Author: Sergio Delgado Rodriguez <[email protected]>
    Date:   Tue Feb 6 15:46:57 2024 -0500

        new_GTFS.org_structure (#307)

        Adding new files for new GTFS architecture. This change does not remove the old files.

    commit fe496d1
    Author: isabelle-dr <[email protected]>
    Date:   Tue Feb 6 14:29:31 2024 -0500

        Removing translations (#306)

        * dummy commit

        * Remove translations part one

        * removing translations

        * Make changes based on review

    * Updated Platforms.md and active_projects.md

    - Added grids to platforms for better visibility.
    - Added mailling lists and other community links to platforms.md
    -Added active projects to active projects.

    ---------

    Co-authored-by: Sergio Delgado Rodriguez <[email protected]>

commit 02d6e1f
Author: Fabien Richard-Allouard <[email protected]>
Date:   Tue Feb 6 16:52:12 2024 -0500

    Moved content to Getting started section (#309)

    * Squashed commit of the following:

    commit fe496d1
    Author: isabelle-dr <[email protected]>
    Date:   Tue Feb 6 14:29:31 2024 -0500

        Removing translations (#306)

        * dummy commit

        * Remove translations part one

        * removing translations

        * Make changes based on review

    * Squashed commit of the following:

    commit 30ce1ef
    Author: Sergio Delgado Rodriguez <[email protected]>
    Date:   Tue Feb 6 15:46:57 2024 -0500

        new_GTFS.org_structure (#307)

        Adding new files for new GTFS architecture. This change does not remove the old files.

    commit fe496d1
    Author: isabelle-dr <[email protected]>
    Date:   Tue Feb 6 14:29:31 2024 -0500

        Removing translations (#306)

        * dummy commit

        * Remove translations part one

        * removing translations

        * Make changes based on review

    * Moved content to Getting started section

    * Added examples page to Getting started

    * Update publishing page in Getting started

commit 72995c0
Author: Tzu-Jen Chan <[email protected]>
Date:   Tue Feb 6 16:37:08 2024 -0500

    [Design Sprint] Add content for documentation landing page (#308)

    * Squashed commit of the following:

    commit 30ce1ef
    Author: Sergio Delgado Rodriguez <[email protected]>
    Date:   Tue Feb 6 15:46:57 2024 -0500

        new_GTFS.org_structure (#307)

        Adding new files for new GTFS architecture. This change does not remove the old files.

    commit fe496d1
    Author: isabelle-dr <[email protected]>
    Date:   Tue Feb 6 14:29:31 2024 -0500

        Removing translations (#306)

        * dummy commit

        * Remove translations part one

        * removing translations

        * Make changes based on review

    * Add content for spec landing page

    * Remove pencil link and add links to spec

* Update documentation section

* Remove pencil link

* Squashed commit of the following:

commit 06414f1
Author: isabelle-dr <[email protected]>
Date:   Tue Feb 6 18:53:21 2024 -0500

    Adding the other sections in the Resource Library (#316)

    * dummy commit

    * Remove translations part one

    * removing translations

    * Make changes based on review

    * Squashed commit of the following:

    commit 30ce1ef
    Author: Sergio Delgado Rodriguez <[email protected]>
    Date:   Tue Feb 6 15:46:57 2024 -0500

        new_GTFS.org_structure (#307)

        Adding new files for new GTFS architecture. This change does not remove the old files.

    * Add Data examples

    * Updating mkdocs.yml file and adding realtime examples

    * Add Fabien's structure in yml file

    * Add content for extension projects

    * Add overview section & lock title so it's not clickable

    * Adding amendment processes

    * Updates to the Resource section

    * Add tools section

    * change name

commit ec2dc50
Author: Tzu-Jen Chan <[email protected]>
Date:   Tue Feb 6 18:34:05 2024 -0500

    Update overview link in documentation (#315)

    * Squashed commit of the following:

    commit 30ce1ef
    Author: Sergio Delgado Rodriguez <[email protected]>
    Date:   Tue Feb 6 15:46:57 2024 -0500

        new_GTFS.org_structure (#307)

        Adding new files for new GTFS architecture. This change does not remove the old files.

    commit fe496d1
    Author: isabelle-dr <[email protected]>
    Date:   Tue Feb 6 14:29:31 2024 -0500

        Removing translations (#306)

        * dummy commit

        * Remove translations part one

        * removing translations

        * Make changes based on review

    * Update overview link

    * o to O

commit e45d117
Author: Sergio Delgado Rodriguez <[email protected]>
Date:   Tue Feb 6 18:07:47 2024 -0500

    [Design Sprint] Move TOC to the right (#313)

    * new_GTFS.org_structure

    Adding new files for new GTFS architecture. This change does not remove the old files.

    * Squashed commit of the following:

    commit 30ce1ef
    Author: Sergio Delgado Rodriguez <[email protected]>
    Date:   Tue Feb 6 15:46:57 2024 -0500

        new_GTFS.org_structure (#307)

        Adding new files for new GTFS architecture. This change does not remove the old files.

    commit fe496d1
    Author: isabelle-dr <[email protected]>
    Date:   Tue Feb 6 14:29:31 2024 -0500

        Removing translations (#306)

        * dummy commit

        * Remove translations part one

        * removing translations

        * Make changes based on review

    * Squashed commit of the following:

    commit 72995c0
    Author: Tzu-Jen Chan <[email protected]>
    Date:   Tue Feb 6 16:37:08 2024 -0500

        [Design Sprint] Add content for documentation landing page (#308)

        * Squashed commit of the following:

        commit 30ce1ef
        Author: Sergio Delgado Rodriguez <[email protected]>
        Date:   Tue Feb 6 15:46:57 2024 -0500

            new_GTFS.org_structure (#307)

            Adding new files for new GTFS architecture. This change does not remove the old files.

        commit fe496d1
        Author: isabelle-dr <[email protected]>
        Date:   Tue Feb 6 14:29:31 2024 -0500

            Removing translations (#306)

            * dummy commit

            * Remove translations part one

            * removing translations

            * Make changes based on review

        * Add content for spec landing page

        * Remove pencil link and add links to spec

    commit 30ce1ef
    Author: Sergio Delgado Rodriguez <[email protected]>
    Date:   Tue Feb 6 15:46:57 2024 -0500

        new_GTFS.org_structure (#307)

        Adding new files for new GTFS architecture. This change does not remove the old files.

    commit fe496d1
    Author: isabelle-dr <[email protected]>
    Date:   Tue Feb 6 14:29:31 2024 -0500

        Removing translations (#306)

        * dummy commit

        * Remove translations part one

        * removing translations

        * Make changes based on review

    * Add Schedule reference document

    This commit adds the content of the Schedule Reference document as it currently is.

    * Squashed commit of the following:

    commit 06ff58d
    Author: Sergio Delgado Rodriguez <[email protected]>
    Date:   Tue Feb 6 17:16:15 2024 -0500

        [Design Sprint] Add Schedule Reference document (#310)

        * new_GTFS.org_structure

        Adding new files for new GTFS architecture. This change does not remove the old files.

        * Squashed commit of the following:

        commit 30ce1ef
        Author: Sergio Delgado Rodriguez <[email protected]>
        Date:   Tue Feb 6 15:46:57 2024 -0500

            new_GTFS.org_structure (#307)

            Adding new files for new GTFS architecture. This change does not remove the old files.

        commit fe496d1
        Author: isabelle-dr <[email protected]>
        Date:   Tue Feb 6 14:29:31 2024 -0500

            Removing translations (#306)

            * dummy commit

            * Remove translations part one

            * removing translations

            * Make changes based on review

        * Squashed commit of the following:

        commit 72995c0
        Author: Tzu-Jen Chan <[email protected]>
        Date:   Tue Feb 6 16:37:08 2024 -0500

            [Design Sprint] Add content for documentation landing page (#308)

            * Squashed commit of the following:

            commit 30ce1ef
            Author: Sergio Delgado Rodriguez <[email protected]>
            Date:   Tue Feb 6 15:46:57 2024 -0500

                new_GTFS.org_structure (#307)

                Adding new files for new GTFS architecture. This change does not remove the old files.

            commit fe496d1
            Author: isabelle-dr <[email protected]>
            Date:   Tue Feb 6 14:29:31 2024 -0500

                Removing translations (#306)

                * dummy commit

                * Remove translations part one

                * removing translations

                * Make changes based on review

            * Add content for spec landing page

            * Remove pencil link and add links to spec

        commit 30ce1ef
        Author: Sergio Delgado Rodriguez <[email protected]>
        Date:   Tue Feb 6 15:46:57 2024 -0500

            new_GTFS.org_structure (#307)

            Adding new files for new GTFS architecture. This change does not remove the old files.

        commit fe496d1
        Author: isabelle-dr <[email protected]>
        Date:   Tue Feb 6 14:29:31 2024 -0500

            Removing translations (#306)

            * dummy commit

            * Remove translations part one

            * removing translations

            * Make changes based on review

        * Add Schedule reference document

        This commit adds the content of the Schedule Reference document as it currently is.

    commit edef886
    Author: Elias Gino Cripotos <[email protected]>
    Date:   Tue Feb 6 17:11:49 2024 -0500

        Changes to Community Section (#311)

        * Squashed commit of the following:

        commit fe496d1
        Author: isabelle-dr <[email protected]>
        Date:   Tue Feb 6 14:29:31 2024 -0500

            Removing translations (#306)

            * dummy commit

            * Remove translations part one

            * removing translations

            * Make changes based on review

        * Squashed commit of the following:

        commit 30ce1ef
        Author: Sergio Delgado Rodriguez <[email protected]>
        Date:   Tue Feb 6 15:46:57 2024 -0500

            new_GTFS.org_structure (#307)

            Adding new files for new GTFS architecture. This change does not remove the old files.

        commit fe496d1
        Author: isabelle-dr <[email protected]>
        Date:   Tue Feb 6 14:29:31 2024 -0500

            Removing translations (#306)

            * dummy commit

            * Remove translations part one

            * removing translations

            * Make changes based on review

        * Updated Platforms.md and active_projects.md

        - Added grids to platforms for better visibility.
        - Added mailling lists and other community links to platforms.md
        -Added active projects to active projects.

        ---------

        Co-authored-by: Sergio Delgado Rodriguez <[email protected]>

    commit 02d6e1f
    Author: Fabien Richard-Allouard <[email protected]>
    Date:   Tue Feb 6 16:52:12 2024 -0500

        Moved content to Getting started section (#309)

        * Squashed commit of the following:

        commit fe496d1
        Author: isabelle-dr <[email protected]>
        Date:   Tue Feb 6 14:29:31 2024 -0500

            Removing translations (#306)

            * dummy commit

            * Remove translations part one

            * removing translations

            * Make changes based on review

        * Squashed commit of the following:

        commit 30ce1ef
        Author: Sergio Delgado Rodriguez <[email protected]>
        Date:   Tue Feb 6 15:46:57 2024 -0500

            new_GTFS.org_structure (#307)

            Adding new files for new GTFS architecture. This change does not remove the old files.

        commit fe496d1
        Author: isabelle-dr <[email protected]>
        Date:   Tue Feb 6 14:29:31 2024 -0500

            Removing translations (#306)

            * dummy commit

            * Remove translations part one

            * removing translations

            * Make changes based on review

        * Moved content to Getting started section

        * Added examples page to Getting started

        * Update publishing page in Getting started

    commit 72995c0
    Author: Tzu-Jen Chan <[email protected]>
    Date:   Tue Feb 6 16:37:08 2024 -0500

        [Design Sprint] Add content for documentation landing page (#308)

        * Squashed commit of the following:

        commit 30ce1ef
        Author: Sergio Delgado Rodriguez <[email protected]>
        Date:   Tue Feb 6 15:46:57 2024 -0500

            new_GTFS.org_structure (#307)

            Adding new files for new GTFS architecture. This change does not remove the old files.

        commit fe496d1
        Author: isabelle-dr <[email protected]>
        Date:   Tue Feb 6 14:29:31 2024 -0500

            Removing translations (#306)

            * dummy commit

            * Remove translations part one

            * removing translations

            * Make changes based on review

        * Add content for spec landing page

        * Remove pencil link and add links to spec

    commit 30ce1ef
    Author: Sergio Delgado Rodriguez <[email protected]>
    Date:   Tue Feb 6 15:46:57 2024 -0500

        new_GTFS.org_structure (#307)

        Adding new files for new GTFS architecture. This change does not remove the old files.

    commit fe496d1
    Author: isabelle-dr <[email protected]>
    Date:   Tue Feb 6 14:29:31 2024 -0500

        Removing translations (#306)

        * dummy commit

        * Remove translations part one

        * removing translations

        * Make changes based on review

    * Move TOC to right side for all pages

    Move TOC to right side for all pages

commit 2248782
Author: isabelle-dr <[email protected]>
Date:   Tue Feb 6 18:05:48 2024 -0500

    Add data examples (#314)

    * dummy commit

    * Remove translations part one

    * removing translations

    * Make changes based on review

    * Squashed commit of the following:

    commit 30ce1ef
    Author: Sergio Delgado Rodriguez <[email protected]>
    Date:   Tue Feb 6 15:46:57 2024 -0500

        new_GTFS.org_structure (#307)

        Adding new files for new GTFS architecture. This change does not remove the old files.

    * Add Data examples

    * Updating mkdocs.yml file and adding realtime examples

    * Add Fabien's structure in yml file

commit 69e0d6f
Author: Fabien Richard-Allouard <[email protected]>
Date:   Tue Feb 6 17:49:15 2024 -0500

    Update documentation section (#312)

    * Squashed commit of the following:

    commit fe496d1
    Author: isabelle-dr <[email protected]>
    Date:   Tue Feb 6 14:29:31 2024 -0500

        Removing translations (#306)

        * dummy commit

        * Remove translations part one

        * removing translations

        * Make changes based on review

    * Squashed commit of the following:

    commit 30ce1ef
    Author: Sergio Delgado Rodriguez <[email protected]>
    Date:   Tue Feb 6 15:46:57 2024 -0500

        new_GTFS.org_structure (#307)

        Adding new files for new GTFS architecture. This change does not remove the old files.

    commit fe496d1
    Author: isabelle-dr <[email protected]>
    Date:   Tue Feb 6 14:29:31 2024 -0500

        Removing translations (#306)

        * dummy commit

        * Remove translations part one

        * removing translations

        * Make changes based on review

    * Moved content to Getting started section

    * Added examples page to Getting started

    * Update publishing page in Getting started

    * Squashed commit of the following:

    commit 02d6e1f
    Author: Fabien Richard-Allouard <[email protected]>
    Date:   Tue Feb 6 16:52:12 2024 -0500

        Moved content to Getting started section (#309)

        * Squashed commit of the following:

        commit fe496d1
        Author: isabelle-dr <[email protected]>
        Date:   Tue Feb 6 14:29:31 2024 -0500

            Removing translations (#306)

            * dummy commit

            * Remove translations part one

            * removing translations

            * Make changes based on review

        * Squashed commit of the following:

        commit 30ce1ef
        Author: Sergio Delgado Rodriguez <[email protected]>
        Date:   Tue Feb 6 15:46:57 2024 -0500

            new_GTFS.org_structure (#307)

            Adding new files for new GTFS architecture. This change does not remove the old files.

        commit fe496d1
        Author: isabelle-dr <[email protected]>
        Date:   Tue Feb 6 14:29:31 2024 -0500

            Removing translations (#306)

            * dummy commit

            * Remove translations part one

            * removing translations

            * Make changes based on review

        * Moved content to Getting started section

        * Added examples page to Getting started

        * Update publishing page in Getting started

    commit 72995c0
    Author: Tzu-Jen Chan <[email protected]>
    Date:   Tue Feb 6 16:37:08 2024 -0500

        [Design Sprint] Add content for documentation landing page (#308)

        * Squashed commit of the following:

        commit 30ce1ef
        Author: Sergio Delgado Rodriguez <[email protected]>
        Date:   Tue Feb 6 15:46:57 2024 -0500

            new_GTFS.org_structure (#307)

            Adding new files for new GTFS architecture. This change does not remove the old files.

        commit fe496d1
        Author: isabelle-dr <[email protected]>
        Date:   Tue Feb 6 14:29:31 2024 -0500

            Removing translations (#306)

            * dummy commit

            * Remove translations part one

            * removing translations

            * Make changes based on review

        * Add content for spec landing page

        * Remove pencil link and add links to spec

    * Squashed commit of the following:

    commit edef886
    Author: Elias Gino Cripotos <[email protected]>
    Date:   Tue Feb 6 17:11:49 2024 -0500

        Changes to Community Section (#311)

        * Squashed commit of the following:

        commit fe496d1
        Author: isabelle-dr <[email protected]>
        Date:   Tue Feb 6 14:29:31 2024 -0500

            Removing translations (#306)

            * dummy commit

            * Remove translations part one

            * removing translations

            * Make changes based on review

        * Squashed commit of the following:

        commit 30ce1ef
        Author: Sergio Delgado Rodriguez <[email protected]>
        Date:   Tue Feb 6 15:46:57 2024 -0500

            new_GTFS.org_structure (#307)

            Adding new files for new GTFS architecture. This change does not remove the old files.

        commit fe496d1
        Author: isabelle-dr <[email protected]>
        Date:   Tue Feb 6 14:29:31 2024 -0500

            Removing translations (#306)

            * dummy commit

            * Remove translations part one

            * removing translations

            * Make changes based on review

        * Updated Platforms.md and active_projects.md

        - Added grids to platforms for better visibility.
        - Added mailling lists and other community links to platforms.md
        -Added active projects to active projects.

        ---------

        Co-authored-by: Sergio Delgado Rodriguez <[email protected]>

    commit 02d6e1f
    Author: Fabien Richard-Allouard <[email protected]>
    Date:   Tue Feb 6 16:52:12 2024 -0500

        Moved content to Getting started section (#309)

        * Squashed commit of the following:

        commit fe496d1
        Author: isabelle-dr <[email protected]>
        Date:   Tue Feb 6 14:29:31 2024 -0500

            Removing translations (#306)

            * dummy commit

            * Remove translations part one

            * removing translations

            * Make changes based on review

        * Squashed commit of the following:

        commit 30ce1ef
        Author: Sergio Delgado Rodriguez <[email protected]>
        Date:   Tue Feb 6 15:46:57 2024 -0500

            new_GTFS.org_structure (#307)

            Adding new files for new GTFS architecture. This change does not remove the old files.

        commit fe496d1
        Author: isabelle-dr <[email protected]>
        Date:   Tue Feb 6 14:29:31 2024 -0500

            Removing translations (#306)

            * dummy commit

            * Remove translations part one

            * removing translations

            * Make changes based on review

        * Moved content to Getting started section

        * Added examples page to Getting started

        * Update publishing page in Getting started

    commit 72995c0
    Author: Tzu-Jen Chan <[email protected]>
    Date:   Tue Feb 6 16:37:08 2024 -0500

        [Design Sprint] Add content for documentation landing page (#308)

        * Squashed commit of the following:

        commit 30ce1ef
        Author: Sergio Delgado Rodriguez <[email protected]>
        Date:   Tue Feb 6 15:46:57 2024 -0500

            new_GTFS.org_structure (#307)

            Adding new files for new GTFS architecture. This change does not remove the old files.

        commit fe496d1
        Author: isabelle-dr <[email protected]>
        Date:   Tue Feb 6 14:29:31 2024 -0500

            Removing translations (#306)

            * dummy commit

            * Remove translations part one

            * removing translations

            * Make changes based on review

        * Add content for spec landing page

        * Remove pencil link and add links to spec

    * Update documentation section

    * Remove pencil link

    ---------

    Co-authored-by: Tzu-Jen Chan <[email protected]>

* Fixed navigation in mkdocs.yml

* Removed old menus

* Improved overview pages

---------

Co-authored-by: Tzu-Jen Chan <[email protected]>
  • Loading branch information
@richfab @tzujenchanmbd
richfab and tzujenchanmbd authored Feb 7, 2024
1 parent 06414f1 commit 9ab6221
Show file tree
Hide file tree
Showing 4 changed files with 80 additions and 116 deletions.
56 changes: 55 additions & 1 deletion docs/documentation/Realtime/overview.md
View file
Original file line number Diff line number Diff line change
@@ -1 +1,55 @@
Breakdown of GTFS RT features
# GTFS Realtime Overview

## Getting Started

Providing users transit data updates in real time greatly enhances their experience of your transit services. Providing up-to-date information about current arrival and departure times allows users to smoothly plan their trips. As a result, in case of an unfortunate delay, a rider would be relieved to know that they can stay home a little bit longer.

GTFS Realtime is a feed specification that allows public transportation agencies to provide realtime updates about their fleet to application developers. It is an extension to [GTFS](../schedule/reference) (General Transit Feed Specification), an open data format for public transportation schedules and associated geographic information. GTFS Realtime was designed around ease of implementation, good GTFS interoperability and a focus on passenger information.

The specification was designed through a partnership of the initial [Live Transit Updates](https://developers.google.com/transit/google-transit#LiveTransitUpdates) partner agencies, a number of transit developers and Google. The specification is published under the [Apache 2.0 License](http://www.apache.org/licenses/LICENSE-2.0.html).

## How do I start?

1. Continue reading the overview below.
2. Decide which [feed entities](feed-entities) you will be providing.
3. Take a look at [example feeds](feed-examples).
4. Create your own feeds using the [reference](reference).
5. [Publish your feed](best-practices/#feed-publishing-general-practices).

## Overview of GTFS Realtime feeds

The specification currently supports the following types of information:

* **Trip updates** - delays, cancellations, changed routes
* **Service alerts** - stop moved, unforeseen events affecting a station, route or the entire network
* **Vehicle positions** - information about the vehicles including location and congestion level

A feed may, although not required to, combine entities of different types. Feeds are served via HTTP and updated frequently. The file itself is a regular binary file, so any type of webserver can host and serve the file (other transfer protocols might be used as well). Alternatively, web application servers could also be used which as a response to a valid HTTP GET request will return the feed. There are no constraints on how frequently nor on the exact method of how the feed should be updated or retrieved.

Because GTFS Realtime allows you to present the _actual_ status of your fleet, the feed needs to be updated regularly - preferably whenever new data comes in from your Automatic Vehicle Location system.

[More about feed entities...](feed-entities)

## Data format

The GTFS Realtime data exchange format is based on [Protocol Buffers](https://developers.google.com/protocol-buffers/)

Protocol buffers are a language- and platform-neutral mechanism for serializing structured data (think XML, but smaller, faster, and simpler). The data structure is defined in a [gtfs-realtime.proto](proto) file, which then is used to generate source code to easily read and write your structured data from and to a variety of data streams, using a variety of languages – e.g. Java, C++ or Python.

[More about Protocol Buffers...](https://developers.google.com/protocol-buffers/).

## Data structure

The hierarchy of elements and their type definitions are specified in the [gtfs-realtime.proto](proto) file.

This text file is used to generate the necessary libraries in your choice of programming language. These libraries provide the classes and functions needed for generating valid GTFS Realtime feeds. The libraries not only make feed creation easier but also ensure that only valid feeds are produced.

[More about the data structure...](reference)

## Getting Help

To participate in discussions around GTFS Realtime and suggest changes and additions to the specification, join the [GTFS Realtime mailing list](http://groups.google.com/group/gtfs-realtime) and follow conversations on the [google/transit GitHub repository](https://github.com/google/transit).

## Google Maps and Live Transit Updates

One of the possible applications that uses GTFS Realtime is [Live Transit Updates](https://developers.google.com/transit/google-transit#LiveTransitUpdates), a feature within Google Maps that provides users with realtime transit information. If you are working for a public transportation agency that is interested in providing realtime updates to Google Maps, please visit the [Google Transit Partner Page](http://maps.google.com/help/maps/transit/partners/live-updates.html).
14 changes: 3 additions & 11 deletions docs/documentation/overview.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,18 +4,10 @@ The General Transit Feed Specification (GTFS) is an [Open Standard](https://www.

GTFS consists of two main parts: [GTFS Schedule](./schedule/reference.md) and [GTFS Realtime](./Realtime/reference.md).

## GTFS Schedule
## [GTFS Schedule](./schedule/reference.md)

GTFS Schedule is a feed specification that defines a common format for static public transportation information. It is composed of a number of text (.txt) files that are contained in a single ZIP file. Each file describes a particular aspect of transit information: stops, routes, trips, fares, etc.

<div class="landing-page">
<a class="button" href="./schedule/components/overview/">Features</a><a class="button" href="./schedule/reference.md">Reference</a><a class="button" href="./schedule/GTFS%20schedule%20best%20Practices.md">Best Practices</a><a class="button" href="./schedule/recent%20additions/">Recent additions</a>
</div>
## [GTFS Realtime](./Realtime/reference.md)

## GTFS Realtime

GTFS Realtime is a feed specification that allows public transportation agencies to provide up-to-date information about current arrival and departure times, service alerts, and vehicle position, allowing users to smoothly plan their trips.

<div class="landing-page">
<a class="button" href="./Realtime/overview/">Overview</a><a class="button" href="./Realtime/reference/">Reference</a><a class="button" href="./Realtime/best%20practices/">Best Practices</a><a class="button" href="./Realtime/feed_entities/overview/">Feed entity</a><a class="button" href="./Realtime/proto/">Protobuf</a><a class="button" href="./Realtime/recent%20additions/">Recent additions</a>
</div>
GTFS Realtime is a feed specification that allows public transportation agencies to provide up-to-date information about current arrival and departure times, service alerts, and vehicle position, allowing users to smoothly plan their trips.
18 changes: 9 additions & 9 deletions docs/documentation/schedule/components/overview.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ As the GTFS Specification grows and adapts to the current needs of transit syste
The following groups of features, called Components, explain the purpose of each feature as well as the files and fields associated with them, helping users to understand which data is needed in order to support a specific feature.


## Base Component
## Base
The features included in this component provide the most basic and essential elements that a GTFS needs to represent a transit service. This includes entries for each individual trip, stop, arrival and departure times and service days among many other important pieces of information. Since all of the features included in the base component are essential to enable a working GTFS feed, all these features should be implemented together.

<div class="grid cards" markdown>
Expand Down Expand Up @@ -49,7 +49,7 @@ The features included in this component provide the most basic and essential ele
</div>


## Accessibility Component
## Accessibility
The Accessibility Component of GTFS contains multiple functionalities to provide information that helps end users navigate and access public transit services. Some of these features can be used to communicate the name and color of a route, making it easier to identify; confirming whether or not a trip and a station are wheelchair accessible, helping users choose the most adequate route; and providing translations in multiple languages, among other things.

<div class="grid cards" markdown>
Expand Down Expand Up @@ -94,7 +94,7 @@ The Accessibility Component of GTFS contains multiple functionalities to provide
</div>


## Fares Component
## Fares
The Fares component includes multiple features that allow to precisely describe a wide variety of pricing structures and payment methods used by different transit agencies around the world, such as zone-based fares and reloadable prepaid cards. This helps users know the correct price applicable to their trip.

<div class="grid cards" markdown>
Expand Down Expand Up @@ -145,7 +145,7 @@ The Fares component includes multiple features that allow to precisely describe
</div>


## Pathways Component
## Pathways
The Pathways component contains features that allow to model in-station paths, helping users navigate transit stations from beginning to end and across multiple levels. Some of these features make it possible to communicate the physical characteristics of each individual section of a path, estimate the time required to navigate them and to match this navigation information with the real-world wayfinding systems used in stations.

<div class="grid cards" markdown>
Expand Down Expand Up @@ -189,7 +189,7 @@ The Pathways component contains features that allow to model in-station paths, h
</div>


## Metadata Component
## Metadata
The Metadata Component contains features that allow to provide further information regarding the producer of the GTFS feed and the feed itself, this includes the names of the organizations as well as contact information.

<div class="grid cards" markdown>
Expand All @@ -210,7 +210,7 @@ The Metadata Component contains features that allow to provide further informati
</div>


## Flexible services Component
## Flexible services
This component contains features that make it possible to communicate service information for flexible services with special operations that might not follow the common behavior of scheduled and/or fixed services.


Expand All @@ -226,7 +226,7 @@ This component contains features that make it possible to communicate service in



## Shapes Component
## Shapes
The Shapes component and feature allows to communicate the path that a vehicle follows along a route. Among other things, this can help trip planners to display the route of a trip so that users can know if the route of a service goes to their destination.


Expand All @@ -242,7 +242,7 @@ The Shapes component and feature allows to communicate the path that a vehicle f



## Transfers Component
## Transfers
The transfers component and feature allow to describe transfers between different public transit services. This gives transit agencies the ability to clearly define the applicable rules for each transfer scenario, so that travelers can know if it’s possible to connect trips.

<div class="grid cards" markdown>
Expand All @@ -258,7 +258,7 @@ The transfers component and feature allow to describe transfers between differen



## Frequency-based services Component
## Frequency-based services
The frequencies component and feature can be used to represent frequency-based trips (e.g. a bus trips running every 10 minutes, a subway or metro service running every 2 minutes), this can be a useful alternative to providing specific timetables, acting as an alternative to some of the information included in the stop times Feature of the Base Component.

<div class="grid cards" markdown>
Expand Down
108 changes: 13 additions & 95 deletions mkdocs.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -136,25 +136,25 @@ nav:
- How to create GTFS: getting_started/how_to_create_GTFS.md
- Check the quality: getting_started/check_the_quality.md
- Publishing: getting_started/publishing.md
- Examples: getting_started/examples.md
- Documentation:
- Basic example: getting_started/examples.md
- Technical Documentation:
- Overview: documentation/overview.md
- Schedule:
- Features:
- Overview: documentation/schedule/components/overview.md
- Base Component: documentation/schedule/components/base.md
- Accesibility Component: documentation/schedule/components/accesibility.md
- Fares Component: documentation/schedule/components/fares.md
- Pathways Component: documentation/schedule/components/pathways.md
- Metadata Component: documentation/schedule/components/metadata.md
- Flexible services Component: documentation/schedule/components/flexible_services.md
- Shapes Component: documentation/schedule/components/shapes.md
- Transfers Component: documentation/schedule/components/transfers.md
- Frequency based services Component: documentation/schedule/components/frequency_based_services.md
- Base: documentation/schedule/components/base.md
- Accesibility: documentation/schedule/components/accesibility.md
- Fares: documentation/schedule/components/fares.md
- Pathways: documentation/schedule/components/pathways.md
- Metadata: documentation/schedule/components/metadata.md
- Flexible services: documentation/schedule/components/flexible_services.md
- Shapes: documentation/schedule/components/shapes.md
- Transfers: documentation/schedule/components/transfers.md
- Frequency based services: documentation/schedule/components/frequency_based_services.md
- Reference: documentation/schedule/reference.md
- Best Practices: documentation/schedule/GTFS schedule best Practices.md
- Recent additions: documentation/schedule/recent additions.md
- Real Time:
- Realtime:
- Overview: documentation/Realtime/overview.md
- Reference: documentation/Realtime/reference.md
- Best Practices: documentation/Realtime/best practices.md
Expand All @@ -168,7 +168,7 @@ nav:
- Community:
- Platforms: community/platforms.md
- Active projects: community/active_projects.md
- Resource library:
- Resource Library:
- Overview: resource_library/overview.md
- Data examples:
- GTFS Schedule data examples:
Expand All @@ -188,91 +188,9 @@ nav:
- Guides and Tutorials: resource_library/tutorials.md
- Tools:
- Data Portals: resource_library/tools/data_portals.md
-
- GTFS extension projects: resource_library/extension_projects.md
- GTFS amendment process:
- GTFS Schedule Amendment Process: resource_library/spec_amendment_process/gtfs_schedule_amendment_process.md
- GTFS Realtime Amendment Process: resource_library/spec_amendment_process/gtfs_realtime_amendment_process.md
- About:
- 5-About/index.md
- GTFS Schedule:
- Getting Started: schedule/index.md
- Reference: schedule/reference.md
- Best Practices: schedule/best-practices.md
- Examples:
- schedule/examples/index.md
- Example GTFS Feed: schedule/example-feed.md
- Routes, stops, and trips: schedule/examples/routes-stops-trips.md
- Continuous stops: schedule/examples/continuous-stops.md
- Text-to-speech: schedule/examples/text-to-speech.md
- Fares v1: schedule/examples/fares-v1.md
- Fares v2: schedule/examples/fares-v2.md
- Frequencies: schedule/examples/frequencies.md
- Pathways: schedule/examples/pathways.md
- Transfers: schedule/examples/transfers.md
- Translations: schedule/examples/translations.md
- Feed information: schedule/examples/feed-info.md
- Dataset attributions: schedule/examples/attributions.md
- Changes:
- schedule/changes/index.md
- Specification Amendment Process: schedule/process.md
- Validate: schedule/validate.md
- Components:
- schedule/components/index.md
- Base Component: schedule/components/base.md
- Accesibility Component: schedule/components/accesibility.md
- Fares Component: schedule/components/fares.md
- Pathways Component: schedule/components/pathways.md
- Metadata Component: schedule/components/metadata.md
- Flexible services Component: schedule/components/flexible_services.md
- Shapes Component: schedule/components/shapes.md
- Transfers Component: schedule/components/transfers.md
- Frequency based services Component: schedule/components/frequency_based_services.md

- GTFS Realtime:
- Getting Started: realtime/index.md
- Reference: realtime/reference.md
- Best Practices: realtime/best-practices.md
- Feed Entities:
- realtime/feed-entities/index.md
- Trip Updates: realtime/feed-entities/trip-updates.md
- Service Alerts: realtime/feed-entities/service-alerts.md
- Vehicle Positions: realtime/feed-entities/vehicle-positions.md
- Feed Examples:
- realtime/feed-examples/index.md
- Trip Updates: realtime/feed-examples/trip-updates.md
- Service Alerts: realtime/feed-examples/service-alerts.md
- Protobuf: realtime/proto.md
- Language Bindings:
- realtime/language-bindings/index.md
- .NET: realtime/language-bindings/dotnet.md
- Java: realtime/language-bindings/java.md
- JavaScript/Node.js: realtime/language-bindings/nodejs.md
- Python: realtime/language-bindings/python.md
- Golang: realtime/language-bindings/golang.md
- Ruby: realtime/language-bindings/ruby.md
- PHP: realtime/language-bindings/php.md
- Changes:
- realtime/changes/index.md
- Specification Amendment Process: realtime/process.md
- Resources:
- resources/index.md
- Getting Started: resources/getting-started.md
- Community: resources/community.md
- Data: resources/data.md
- Software for Creating APIs: resources/software-for-creating-apis.md
- Agency Tools: resources/agency-tools.md
- Hardware: resources/hardware.md
- Apps: resources/apps.md
- SDKs: resources/sdk.md
- Visualizations: resources/visualizations.md
- GTFS: resources/gtfs.md
- GTFS Realtime: resources/gtfs-realtime.md
- SIRI: resources/siri.md
- Multimodal: resources/multimodal.md
- Other: resources/other.md
- Extensions:
- extensions/index.md
- Fares v2: extensions/fares-v2.md
- Flex: extensions/flex.md
- About: about.md

0 comments on commit 9ab6221

Please sign in to comment.