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

chore: add web validator information to README #1399

Merged
merged 11 commits into from
Apr 26, 2023

Conversation

davidgamez
Copy link
Member

Summary:

This is part of the pre-release tasks. This PR adds the GTFS Web validator information to the project root's README file.

Expected behavior:

The GTFS Web Validator information is in the project root's README file and linking web client and service sub-packages README for more information.

Please make sure these boxes are checked before submitting your pull request - thanks!

  • Run the unit tests with gradle test to make sure you didn't break anything
  • Format the title like "feat: [new feature short description]". Title must follow the Conventional Commit Specification(https://www.conventionalcommits.org/en/v1.0.0/).
  • Linked all relevant issues
  • Include screenshot(s) showing how this pull request works and fixes the issue(s)

Copy link
Contributor

@isabelle-dr isabelle-dr left a comment

Choose a reason for hiding this comment

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

Can we have the following order in the README.md:

  • Introduction
  • Using the web-based validator
  • Using the Desktop app
  • Using the command line
  • Using Docker

Also, could you rename the video to validator_demo.mp4 and put it at the top below the introduction instead of the one we currently have showing the Desktop app?

README.md Outdated
The GTFS Web Validator can be accessed from [https://gtfs-validator.mobilitydata.org/](https://gtfs-validator.mobilitydata.org/).
The GTFS Web Validator accepts locally saved datasets and datasets available via the Web. Validation reports are available 30 days after creation and can be shared with their unique link.

The GTFS Web Validator contains two main components the GTFS Web Validator Client and the GTFS Validator Web Service. More information about these components can be found in [GTFS Web Validator Client](./web/client/README.md) and [GTFS Validator Web Service](./web/service/README.md)
Copy link
Contributor

Choose a reason for hiding this comment

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

We're missing a ":" after "two main components".

@isabelle-dr isabelle-dr marked this pull request as ready for review April 26, 2023 20:18
@isabelle-dr isabelle-dr merged commit 80550f3 into master Apr 26, 2023
332 checks passed
@isabelle-dr isabelle-dr deleted the chore/update-readme-webvalidator branch April 26, 2023 20:59
@github-actions
Copy link
Contributor

✅ Rule acceptance tests passed.
New Errors: 0 out of 1426 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
Dropped Errors: 0 out of 1426 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
New Warnings: 0 out of 1426 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
Dropped Warnings: 0 out of 1426 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
0 out of 1426 sources (~0 %) are corrupted.
Commit: 6697838
Download the full acceptance test report here (report will disappear after 90 days).
✅ Rule acceptance tests passed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update README.md with Web UI, publish 4.1.0 release, update external links to the Web UI
2 participants