brendannee / gtfs.org

Source code for gtfs.org.

GTFS.org

Source code for gtfs.org.

This site was built using MkDocs, a static site generator, and Material for MkDocs, a technical documentation theme for MkDocs.

Editing site

To propose a feature, content addition, or UI/UX improvement, open an issue or pull request on this repository. To edit site content, see instructions below.

Editing site content

The GTFS Documentation Platform is based on open source content pulled from various repositories. To propose edits to content, make an issue or pull request in the respective source-of-truth repository found in the table below.

Sources of truth & licenses

gtfs.org	Source of truth	License
/	https://github.com/MobilityData/gtfs.org/blob/main/docs/index.md	CC BY 3.0
/background/	https://github.com/MobilityData/gtfs.org/blob/main/docs/background.md	CC BY 3.0
/schedule/	https://github.com/MobilityData/gtfs.org/blob/main/docs/schedule/index.md	CC BY 3.0
/schedule/reference/	https://github.com/google/transit/blob/master/gtfs/spec/en/reference.md	Apache License 2.0
/schedule/best-practices/	https://github.com/MobilityData/GTFS_Schedule_Best-Practices	CC BY 3.0
/schedule/examples/	https://github.com/MobilityData/gtfs.org/blob/main/docs/schedule/examples/index.md	CC BY 3.0
/schedule/example-feed/	https://github.com/google/transit/blob/master/gtfs/spec/en/examples/README.md	Apache License 2.0
/schedule/data-examples/	https://github.com/google/transit/blob/master/gtfs/spec/en/examples/data-examples.md	Apache License 2.0
/schedule/changes/	https://github.com/google/transit/blob/master/gtfs/CHANGES.md	Apache License 2.0
/schedule/changes/process	https://github.com/google/transit/blob/master/gtfs/CHANGES.md	Apache License 2.0
/schedule/changes/guiding-principles	https://github.com/google/transit/blob/master/gtfs/CHANGES.md	Apache License 2.0
/schedule/changes/revision-history	https://github.com/google/transit/blob/master/gtfs/CHANGES.md	Apache License 2.0
/realtime/	https://github.com/google/transit/blob/master/gtfs-realtime/spec/en/README.md	Apache License 2.0
/realtime/reference/	https://github.com/google/transit/blob/master/gtfs-realtime/spec/en/reference.md	Apache License 2.0
/realtime/proto/	https://github.com/google/transit/blob/master/gtfs-realtime/proto/gtfs-realtime.proto	Apache License 2.0
/realtime/best-practices/	https://github.com/MobilityData/GTFS_realtime_Best-Practices	CC BY 3.0
/realtime/feed-entities/	https://github.com/google/transit/blob/master/gtfs-realtime/spec/en/feed-entities.md	Apache License 2.0
/realtime/trip-updates/	https://github.com/google/transit/blob/master/gtfs-realtime/spec/en/trip-updates.md	Apache License 2.0
/realtime/service-alerts/	https://github.com/google/transit/blob/master/gtfs-realtime/spec/en/service-alerts.md	Apache License 2.0
/realtime/vehicle-positions/	https://github.com/google/transit/blob/master/gtfs-realtime/spec/en/vehicle-positions.md	Apache License 2.0
/realtime/examples/	https://github.com/MobilityData/gtfs.org/blob/main/docs/realtime/examples/index.md	CC BY 3.0
/realtime/feed-examples/	https://github.com/google/transit/blob/master/gtfs-realtime/spec/en/examples	Apache License 2.0
/realtime/language-bindings/*/	https://github.com/MobilityData/gtfs-realtime-bindings	Apache License 2.0
/realtime/changes/	https://github.com/google/transit/blob/master/gtfs-realtime/CHANGES.md	Apache License 2.0
/realtime/process/	https://github.com/google/transit/blob/master/gtfs-realtime/CHANGES.md	Apache License 2.0
/realtime/guiding-principles/	https://github.com/google/transit/blob/master/gtfs-realtime/CHANGES.md	Apache License 2.0
/realtime/revision-history/	https://github.com/google/transit/blob/master/gtfs-realtime/CHANGES.md	Apache License 2.0
/realtime/extensions/	https://github.com/google/transit/blob/master/gtfs-realtime/CHANGES.md	Apache License 2.0
/resources/*/	https://github.com/CUTR-at-USF/awesome-transit/blob/master/README.md	CC0 1.0 Universal
/extensions/	https://github.com/MobilityData/gtfs.org/blob/main/docs/extensions.md	CC BY 3.0
/about/	https://github.com/MobilityData/gtfs.org/blob/main/docs/about.md	CC BY 3.0

Building the site locally

1. Clone this repository: git clone https://github.com/MobilityData/gtfs.org
2. Ensure you have an up-to-date version of pip: pip install pip
3. Have requirements.txt installed: pip install ~/mobilitydata/gtfs.org/requirements.txt
4. In the terminal, navigate to the repository directory (~/mobilitydata/gtfs.org) and run this command to update the content for the specification references and best practices: bash scripts/fetchdata.sh
5. To run the site locally: mkdocs serve
6. To deploy the site to GitHub Pages: mkdocs gh-deploy

Updating site structure

If a source of truth is specified, the site content is pulled, cleaned programatically, and given a directory destination in the repository. If a source of truth is unspecified, the content lives in this repository. The site structure is manually built in mkdocs.yml under nav: .

License

Except as otherwise noted, the content of this site is licensed under the Creative Commons Attribution 3.0 License, and code samples are licensed under the Apache 2.0 License.