Final documentaiton update for v1.3.1 -- Deep Dive

README.md

@@ -18,7 +18,7 @@ This command-line tool written in Java that performs the following steps:
 ## via GitHub Actions - run the validator on any gtfs archive available on a public url
 
 ## TLDR;
-Fork this repository, open a PR on master within it, edit the file `.github/workflows/end_to_end.yml` following instructions on lines 5, 6, 46-48 and **push** on your PR branch. Name your branch from the agency/authority/publisher of the feed you are testing.
+Fork this repository, open a PR on master within it, edit the file `.github/workflows/end_to_end.yml` following instructions on lines 5, 43-45 and **push** on your PR branch. Name your branch from the agency/authority/publisher of the feed you are testing.
 You should now see the workflow `End to end / run-on-data` start automatically in your PR checks, running the validator on the dataset you just added. The validation report is collected as a run artifact in the Actions tab of your fork repository on GitHub.
 
 If the workflow run crashes or something doesn't look right in the validation report json file, **please see the [Contribute](#Contribute) section, we may be able to help!**
@@ -30,15 +30,13 @@ If the workflow run crashes or something doesn't look right in the validation re
 1. **wait** for the fork creation, you should now see your fork (https://github.com/YOUR_USERNAME/gtfs-validator)
 1. **navigate** to `.github/workflows/end_to_end.yml`
 1. **clic** the *crayon* icon to enter edit mode
-1. **comment** line 5 by adding a `#` at the beginning, right before `branches:`. *It should turn grey when commented out*
-1. **uncomment** line 6 by removing the first `#` character
-1. on line 6, **replace** `your-prbranch` by something significant like `societe-de-transport-de-montreal` if you were adding a dataset from *STM*
+1. on line 5, **replace** `transport-agency-name` by something significant like `societe-de-transport-de-montreal` if you were adding a dataset from *STM*
 1. **keep it around** as you'll need it in *step 18.*
-1. **uncomment** line 46 by removing the `#` character
-1. on line 46, **replace** `ACRONYM` by some acronym for the Agency/publisher
-1. **uncomment** line 47 by removing the `#` character
-1. on line 47, **replace** `[[[ACRONYM]]]` in `[[[ACRONYM]]].zip` by what you put down in step 12 - **NO SPACES OR SPECIAL CHARACTERS -- keep the .zip extension intact**
-1. on line 47, **replace** `DATASET_PUBLIC_URL` by a *public url* pointing to a [GTFS Schedule](https://gtfs.mobilitydata.org/spec/gtfs-schedule) zip archive
+1. **uncomment** line 43 by removing the `#` character
+1. on line 43, **replace** `ACRONYM` by some acronym for the Agency/publisher, in our example that would be `STM`
+1. **uncomment** line 44 by removing the `#` character
+1. on line 44, **replace** `[[[ACRONYM]]]` in `[[[ACRONYM]]].zip` by what you put down in step 12 - **NO SPACES OR SPECIAL CHARACTERS -- keep the .zip extension intact**
+1. on line 44, **replace** `DATASET_PUBLIC_URL` by a *public url* pointing to a [GTFS Schedule](https://gtfs.mobilitydata.org/spec/gtfs-schedule) zip archive
 1. **clic** on the *green* `Start commit` button on the right of the page
 1. **select the option ` Create a new branch for this commit and start a pull request.`**
 1. **replace** the proposed default branch name by what you got from *step 10.*