Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update docs to clarify path to documentation for previous versions of the validator #905

Merged
merged 19 commits into from
Aug 25, 2021
Merged
Changes from 13 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 12 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@

A GTFS Schedule (static) [General Transit Feed Specification (GTFS)](https://gtfs.mobilitydata.org/spec/gtfs-schedule) feed validator

This README contains information for master branch of this project, which is under active development. If you'd like to view documentation for past releases of the project, see:
* [v1.4.0](https://github.com/MobilityData/gtfs-validator/blob/v1.4.0/README.md)
lionel-nj marked this conversation as resolved.
Show resolved Hide resolved
* [v2.0.0](https://github.com/MobilityData/gtfs-validator/blob/v2.0.0/README.md)

# Introduction
This is a command-line tool written in Java that performs the following steps:
1. Loads input GTFS zip file from a URL or disk
lionel-nj marked this conversation as resolved.
Show resolved Hide resolved
Expand All @@ -11,16 +15,16 @@ This is a command-line tool written in Java that performs the following steps:
# Run the app via command line
### Setup
1. Install [Java 8 or higher](https://www.oracle.com/java/technologies/javase-downloads.html)
1. Download [gtfs-validator-v2.0.0_cli.jar](https://github.com/MobilityData/gtfs-validator/releases/download/v2.0.0/gtfs-validator-v2.0.0_cli.jar)
1. Download the latest snapshot jar of the validator from the artifacts generated by the [`Test Package Document`](https://github.com/MobilityData/gtfs-validator/actions/workflows/test_pack_doc.yml) workflow.
lionel-nj marked this conversation as resolved.
Show resolved Hide resolved

### Run it
To validate a GTFS dataset on your computer:

`java -jar gtfs-validator-v2.0.0_cli.jar -i /myDirectory/gtfs.zip -o output -c ca`
`java -jar gtfs-validator-v-snapshot_cli.jar -i /myDirectory/gtfs.zip -o output -c ca`

To download and validate a GTFS dataset from a URL:

`java -jar gtfs-validator-v2.0.0_cli.jar -u https://www.abc.com/gtfs.zip -o output -c ca`
`java -jar gtfs-validator-v-snapshot_cli.jar -u https://www.abc.com/gtfs.zip -o output -c ca`

where:
* `--input` or `-i`: the path to the GTFS file (e.g., `/myDirectory/gtfs.zip`)
Expand All @@ -34,15 +38,15 @@ More detailed instructions are on our ["Usage"](/docs/USAGE.md) page.
# Run the app using Docker
### Setup
1. Download and install [Docker](https://docs.docker.com/get-started/)
1. Pull the [latest Docker image for this project](https://github.com/orgs/MobilityData/packages/container/package/gtfs-validator). For example, `docker pull ghcr.io/mobilitydata/gtfs-validator:v2.0.0`.
1. Pull the [latest Docker image for this project](https://github.com/orgs/MobilityData/packages/container/package/gtfs-validator). For example, `docker pull ghcr.io/mobilitydata/gtfs-validator` for the latest snapshot version of the validator.

### Run it

#### For Mac and Linux

To run the Docker image in a new container:

`docker run -v /myDirectory:/theContainerDirectory -it ghcr.io/mobilitydata/gtfs-validator:v2.0.0`
`docker run -v /myDirectory:/theContainerDirectory -it ghcr.io/mobilitydata/gtfs-validator:latest`

where:
* `-v /myDirectory:/theContainerDirectory`: syntax to share directories and data between the container and the host (your computer). With the above command, any files that you place in `/myDirectory` on the host will show up in `/theContainerDirectory` inside the container and vice versa.
Expand All @@ -55,7 +59,9 @@ The validator can then be executed via bash commands. See the [preceeding instru

# Validation rules
* [Implemented rules](/RULES.md)
* [Possible future rules](https://github.com/MobilityData/gtfs-validator/issues?q=is%3Aopen+is%3Aissue+label%3A%22new+rule%22)
* [GTFS Reference related rules](https://github.com/MobilityData/gtfs-validator/labels/Rules%20-%20GTFS%20Reference)
* [GTFS Best Practices related rules](https://github.com/MobilityData/gtfs-validator/labels/Rules%20-%20GTFS%20Best%20Practices)
* [Common cases of bad data related rules](https://github.com/MobilityData/gtfs-validator/labels/Rules%20-%20Common%20cases%20of%20bad%20data)

Have a suggestion for a new rule? Open [an issue](https://github.com/MobilityData/gtfs-validator/issues/new/choose). You can see the complete process for adding new rules on the ["Adding new rules"](/docs/NEW_RULES.md) page.

Expand Down