Skip to content

Commit

Permalink
Add Best Practices source documentation in the google/transit repo (#447
Browse files Browse the repository at this point in the history
)

* Add Schedule Best Practices

* Add Realtime Best Practices

* Update readme

* Delete gtfs/best-practices/.DS_Store

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* fix broken link

* Update README.md

* small link fix

* small change

* Update README.md with new Realtime issue link
  • Loading branch information
isabelle-dr authored May 12, 2024
1 parent 71fc99d commit 08323db
Show file tree
Hide file tree
Showing 11 changed files with 510 additions and 2 deletions.
19 changes: 19 additions & 0 deletions gtfs-realtime/best-practices/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# GTFS Realtime Best Practices

These are recommended practices for describing real-time public transportation services in the [GTFS Realtime Reference](../spec/en/reference.md) format. These complement the explicit recommendations outlined in the GTFS Realtime Reference using the terms “recommend” or “should”. Although not mandatory, following these best practices can significantly improve the quality of the data and the overall experience for riders.
These practices have been synthesized from the experience of the [GTFS Best Practices working group members](https://gtfs.org/schedule/best-practices/#gtfs-best-practices-working-group) and application-specific GTFS practice recommendations. See the [FAQ](https://gtfs.org/schedule/best-practices/#frequently-asked-questions-faq) for more information.

---
⚠️ **NOTE: The GTFS Realtime Best Practices are in the process of being merged into the [GTFS Realtime Reference](../spec/en/reference.md) (see [issue #396](https://github.com/google/transit/issues/396) and [issue #451](https://github.com/google/transit/issues/451) for more information).**
**New Best Practices will be added directly to the GTFS Realtime Reference. If you'd like to suggest a new Best practice, you can:**
- **look at the existing [list of outstanding issues and PRs](https://github.com/google/transit/issues/421). If your new Best Practice idea is referenced on this list, comment on the issue**
- **[open a new issue](https://github.com/google/transit/issues/new/choose)**
- **open a Pull Request following the [GTFS Realtime Amendment Process](https://gtfs.org/realtime/process/).**
---

## Documentation Structure

The GTFS Realtime Best Practices are written in Markdown and are organized by Message and by use case.

* `field_name`: The name of the GTFS Realtime field being described
* `recommendations`: An array of the recommendations provided for each field_name
163 changes: 163 additions & 0 deletions gtfs-realtime/best-practices/best-practices.md

Large diffs are not rendered by default.

5 changes: 3 additions & 2 deletions gtfs/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
This directory contains GTFS Specification and documentation.
This directory contains the official General Transit Feed Specification (GTFS) Schedule reference documentation.

### Quick links
- [Documentation](spec/en)
- [GTFS Reference](spec/en)
- [GTFS Best Practices](best-practices)
- [How to change the specification?](CHANGES.md)
21 changes: 21 additions & 0 deletions gtfs/best-practices/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# GTFS Schedule Best Practices

These are recommended practices for describing public transportation services in the [GTFS Schedule Reference](../spec/en/reference.md) format. These complement the explicit recommendations outlined in the GTFS Schedule Reference using the terms “recommend” or “should”. Although not mandatory, following these best practices can significantly improve the quality of the data and the overall experience for riders.

These practices have been synthesized from the experience of the [GTFS Best Practices working group members](https://gtfs.org/schedule/best-practices/#gtfs-best-practices-working-group) and application-specific GTFS practice recommendations. See the [FAQ](https://gtfs.org/schedule/best-practices/#frequently-asked-questions-faq) for more information.

---
⚠️ **NOTE: The GTFS Schedule Best Practices are in the process of being merged into the [GTFS Schedule Reference](../spec/en/reference.md) (see [issue #396](https://github.com/google/transit/issues/396) and [issue #451](https://github.com/google/transit/issues/451) for more information).**
**New Best Practices will be added directly to the GTFS Realtime Reference. If you'd like to suggest a new Best practice, you can:**
- **look at the existing [list of outstanding issues and PRs](https://github.com/google/transit/issues/421). If your new Best Practice idea is referenced on this list, comment on the issue**
- **[open a new issue](https://github.com/google/transit/issues/new/choose)**
- **open a Pull Request following the [GTFS Schedule Spec Amendment Process](https://gtfs.org/schedule/process/).**
---


## Documentation Structure

The GTFS Schedule Best Practices are written in Markdown and are organized by Message and by use case.

* `field_name`: The name of the GTFS Schedule field being described
* `recommendations`: An array of the recommendations provided for each field_name
300 changes: 300 additions & 0 deletions gtfs/best-practices/best-practices.md

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions gtfs/best-practices/images/branching.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions gtfs/best-practices/images/inlining.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions gtfs/best-practices/images/lasso-route.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions gtfs/best-practices/images/loop-route.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added gtfs/best-practices/images/rmi-small.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added gtfs/best-practices/images/rmi.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 08323db

Please sign in to comment.