Skip to content
This repository has been archived by the owner on May 21, 2024. It is now read-only.

Add GTFS-RT Best Practices documentation #1

Merged
merged 71 commits into from
May 19, 2021
Merged

Add GTFS-RT Best Practices documentation #1

merged 71 commits into from
May 19, 2021

Conversation

minhhpham
Copy link
Contributor

@minhhpham minhhpham commented May 13, 2019

Refer to https://github.com/MobilityData/Tasks/issues/6.

All Markdown files in en/ directory are combined into index.md by running en/combine.sh.

Do not change index.md directly - change the other .md files and re-generate index.md.

I gathered ideas of best practices by searching for message names in my emails to look for discussions and from the GTFS Realtime Validator Rules.

TODO:

EDIT April 1, 2021 - Some checkboxes that require further community discussion have been moved to #5 for further analysis outside this PR

en/TripUpdate.md Outdated Show resolved Hide resolved
en/about.md Outdated Show resolved Hide resolved
en/about.md Outdated Show resolved Hide resolved
en/about.md Outdated Show resolved Hide resolved
en/Frequency-based.md Outdated Show resolved Hide resolved
@giocorti
Copy link

Thanks for the draft! In addition to my inline comments, I have a few suggestions below:

  • "GTFS-realtime" and "GTFS-rt" are used interchangeably. I think we should just pick and use one.
  • It looks like fields with no recommendations have also been included. Can we eliminate these fields before publishing the final version in order to make the document more concise?

Let me know what you think.

@minhhpham
Copy link
Contributor Author

Thanks @giocorti! I pushed a new commit with the changes you suggested.

  • I changed all "GTFS-rt" into "GTFS-Realtime".
  • I would keep the fields with empty recommendation for now as placeholders for more suggestions. Other reviewers can look at the fields and may think of some recommendations to add.
  • We will need to discuss with MobilityData group about GTFS-Realtime Best Practices Working Group.

Copy link

@heidiguenin heidiguenin left a comment

Choose a reason for hiding this comment

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

Some suggestions and questions.

README.md Outdated Show resolved Hide resolved
index.md Outdated Show resolved Hide resolved
index.md Outdated Show resolved Hide resolved
en/Frequency-based.md Outdated Show resolved Hide resolved
index.md Outdated Show resolved Hide resolved
index.md Outdated Show resolved Hide resolved
index.md Outdated Show resolved Hide resolved
en/FeedHeader.md Outdated Show resolved Hide resolved
index.md Outdated Show resolved Hide resolved
index.md Outdated Show resolved Hide resolved
index.md Outdated

If a GTFS-realtime-consuming application makes requirements or recommendations for GTFS-realtime data practices that are not described here, it is recommended to publish a document with those requirements or recommendations to supplement these common best practices.

## GTFS-realtime Best Practices Working Group
Copy link
Member

Choose a reason for hiding this comment

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

Needs to be updated based on how we decide to get community input on this.

@barbeau barbeau changed the title Initial Commit of Best Practices Document. Add GTFS-RT Best Practices documentation Sep 24, 2020
en/StopTimeUpdate.md Outdated Show resolved Hide resolved
en/StopTimeUpdate.md Outdated Show resolved Hide resolved
en/FeedEntity.md Outdated Show resolved Hide resolved
barbeau added 26 commits May 5, 2021 16:01
Also make some descriptions more concise
This mirrors the content at https://github.com/MobilityData/GTFS_Schedule_Best-Practices for the GTFS Schedule Best Practices. The individual files will be processed and combined separately.
@barbeau barbeau merged commit d420dec into master May 19, 2021
@barbeau barbeau deleted the Initial_commit branch May 19, 2021 20:06
barbeau added a commit that referenced this pull request May 19, 2021
Co-Authored-By: Minh Pham <minhpham@mail.usf.edu>
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants