✨ New Documentation (No large files!) ✨

.github/CODEOWNERS

@@ -1,4 +1,4 @@
 # See https://help.github.com/articles/about-codeowners/
 
-# An IBI Group OTP/Data Tools member is required to approve PR merges
+# An Arcadis OTP/TRANSIT-data-tools member is required to approve PR merges
 * @ibi-group/otp-data-tools

docs/dev/deployment.md

@@ -143,7 +143,7 @@ AUTH0_CLIENT_ID: your-auth0-client-id
 
 Update the following properties in `datatools-server` and `env.yml` to reflect the secure Auth0 application settings.
 
-**Note:** For older Auth0 accounts or tenants, utilizing the Auth0 secret token with the HS256 algorithm is possible. However, newer Auth0 tenants will need to specify the absolute path of their `.pem` file in the `AUTH0_PUBLIC_KEY` property. This public key only needs to be downloaded one time for your Auth0 tenant at `https://[your_domain].auth0.com/pem`.
+**Note:** For older Auth0 accounts or tenants, it is possible to use the Auth0 secret token with the HS256 algorithm is possible. However, newer Auth0 tenants will need to specify the absolute path of their `.pem` file in the `AUTH0_PUBLIC_KEY` property. This public key only needs to be downloaded one time for your Auth0 tenant at `https://[your_domain].auth0.com/pem`.
 
 ```yaml
 AUTH0_SECRET: your-auth0-client-secret # used for pre-September 2017 Auth0 accounts
@@ -166,7 +166,7 @@ To allow for the creation, deletion and editing of users you must generate a tok
 
 If using OIDC-conformant clients/APIs (which appears to be mandatory for new Auth0 tenants), you must set up a custom Auth0 action to add `app_metadata` and `user_metadata` to the user's id token (Note: this is not the default for older, "legacy" Auth0 accounts).
 
-To set up the action, go to Actions > Flows > Login, then under Add action > Custom, click on `Create Action`. Fill in the action name and pick a recommended runtime, and click on `Create`. Modify the function `onExecutePostLogin` as follows, then click Save Draft:
+To set up the action, go to Actions > Flows > Login, then under Add action > Custom, click `Create Action`. Fill in the action name and pick a recommended runtime, and click `Create`. Modify the function `onExecutePostLogin` as follows, then click `Save Draft`:
 
 ```js
 exports.onExecutePostLogin = async (event, api) => {
@@ -178,10 +178,10 @@ exports.onExecutePostLogin = async (event, api) => {
 };
 ```
 If you want the rule to apply only to specific clients, you can retain the conditional block that checks the `context.clientID` value. Otherwise, you can remove this conditional block if it's not needed.
-This rule will ensure that app_metadata and user_metadata are included in the user's token, as required for OIDC-conformant clients/APIs in new Auth0 tenants.
+This rule will ensure that `app_metadata` and `user_metadata` are included in the user's token, as required for OIDC-conformant clients/APIs in new Auth0 tenants.
 
-You can test the action with mock token data using the Test tab. Once ready, click Deploy, then click Back to Flow.
-In the diagram, drag the action between the Start and Complete steps, then click Apply.
+You can test the action with mock token data using the Test tab. Once ready, click `Deploy`, then click `Back to Flow`.
+In the diagram, drag the action between the Start and Complete steps, then click `Apply`.
 You can test that the action is correctly executed by logging-in to datatools with an admin user
 and checking that the Admin functionality is available.
 

docs/dev/development.md

@@ -1,5 +1,5 @@
 # Development
-These instructions should allow you to get Data Tools / Editor / Catalogue up and running within an integrated development environment, allowing you to work on the code and debug it. We all use IntelliJ so instructions will currently be only for that environment.
+These instructions should allow you to get TRANSIT-data-tools / Editor / Catalogue up and running within an integrated development environment, allowing you to work on the code and debug it. We all use IntelliJ so instructions will currently be only for that environment.
 ## Components
 The system is made up of two different projects:
 

docs/index.md

@@ -1,7 +1,7 @@
-# IBI Transit Data Tools (TRANSIT-data-tools)
+# Arcadis TRANSIT-data-tools
 
-The IBI Transit Data Tools suite provides web-based tools for creating, managing, evaluating, and publishing transit data, specifically data stored in the General Transit Feed Specification (GTFS) format.
+The Arcadis TRANSIT-data-tools suite provides web-based tools for creating, managing, evaluating, and publishing transit data, specifically data stored in the General Transit Feed Specification (GTFS) format.
 
 ![feed-profile](https://datatools-builds.s3.amazonaws.com/docs/intro/feed-profile.png)
 
-To get started, click on a topic from the table of contents on the left pane.
+To get started, select a topic from the table of contents on the left pane.

docs/user/add-deployment-server.md

@@ -1,29 +1,29 @@
-# Adding an OTP Deployment Server in Data Tools
+# Adding an OTP Deployment Server in TRANSIT-data-tools
 
 Assumptions:
 
-* [X] You are an admin for Data Tools.
+* [X] You are an admin for TRANSIT-data-tools.
 * [X] You have [set up OTP UI and backend servers on AWS](./setting-up-aws-servers.md).
 * [X] You have a private key file (usually ends in `.pem`) to connect to that AWS environment and EC2 servers via ssh.
 
-From `Administration > Deployment servers`, click on `+ Add Server`.
+From `Administration > Deployment servers`, click `+ Add Server`.
 
 ## General Server Properties
 
 | Property | Description |
 |----------|-------------|
 | Name     | A descriptive display name for the server.        |
-| Public URL | The URL where the public can access the Data Tools UI, e.g. `https://otp-mod-ui.ibi-transit.com`. It is typically the  CNAME of the CloudFront mirror of the AWS S3 bucket you created or picked for this deployment.         |
+| Public URL | The URL where the public can access the TRANSIT-data-tools UI, e.g. `https://otp-mod-ui.ibi-transit.com`. It is typically the  CNAME of the CloudFront mirror of the AWS S3 bucket you created or picked for this deployment.         |
 | Internal URLs (Optional) | The URL(s) based on the UI server IP address(es). |
-| S3 bucket name | The name of the AWS S3 bucket you created or picked for this deployment, where Data Tools will share files with the OTP servers. |
+| S3 bucket name | The name of the AWS S3 bucket you created or picked for this deployment, where TRANSIT-data-tools will share files with the OTP servers. |
 | Admin access only? | Check this option to only allow logins from Data Tool admins. |
 | Project specific? (Optional) | Select a project to only allow the GTFS feeds of that project (e.g. within a region) to be deployed to this server. Leave blank to remove the project restriction. |
-|AWS Role|The IAM role that the Data Tools application must assume in order to access AWS resources (e.g., writing to S3 buckets or starting EC2 machines). See [Delegate Third Party Access](../setting-up-aws-servers#delegate-third-party-account-access) for more info.|
+|AWS Role|The IAM role that the TRANSIT-data-tools application must assume in order to access AWS resources (e.g., writing to S3 buckets or starting EC2 machines). See [Delegate Third Party Access](../setting-up-aws-servers#delegate-third-party-account-access) for more info.|
 | Use elastic load balancer (ELB) | **We recommend using an elastic load balancer (ELB)**. Behind the scenes, a new server is initialized and added to the load balancer, and old servers are removed and destroyed without interruption to the user. <br><br>The load balancer also allows instantiating multiple OTP servers on large deployments. (You can start, add, or remove more than one OTP server to the load balancer.)
 
 ## Load Balancer Properties
 
-(Applies to Data Tools versions prior to October 2019.)
+(Applies to TRANSIT-data-tools versions prior to October 2019.)
 
 | Property | Description |
 |----------|-------------|

docs/user/deploying-feeds.md

@@ -4,7 +4,7 @@ Assumptions:
 
 * [X] You have [loaded a GTFS feed into a project](./managing-projects-feeds.md).
 * [X] You have a deployment server available [(example: AWS)](./add-deployment-server.md).
-* [X] [An osm-lib server has been set up](https://github.com/conveyal/osm-lib) for Data Tools to fetch Open Streets Map (OSM) data.
+* [X] [An osm-lib server has been set up](https://github.com/conveyal/osm-lib) for TRANSIT-data-tools to fetch Open Streets Map (OSM) data.
 
 ## Executing a deployment
 
@@ -32,7 +32,7 @@ The pane also has an option to upload Custom POI CSV files. These files contain
 
 ## Watching deployments take place
 
-After you click on `Deploy`, you can watch the deployment progress from the right-hand panel:
+After you click `Deploy`, you can watch the deployment progress from the right-hand panel:
 
 1. The data bundle is uploaded to S3.
 2. One EC2 server is commissioned.

docs/user/editor/fares.md

@@ -1,5 +1,7 @@
 # Fares
 
+## Fares Overview
+
 ### Fare attributes
 
 Fare attributes describe the basic information about a fare including the price, currency type and transfer information. See the [GTFS specification fare attribute reference](https://gtfs.org/schedule/reference/#fare_attributestxt) for more information.
@@ -12,18 +14,18 @@ Fare rules describe how much riders pay to use a transit system, based on factor
 
 To begin editing fares, click the fare ticket button on the lefthand navigation bar (outlined in red).
 
-Choose a fare from the list to begin editing. To create a new fare, click `+ New fare`, or, if this is the first fare being created for this feed, select `+ Create first fare` (highlighted in yellow).
+Choose a fare from the list to begin editing. To create a new fare, click `+ New fare`, or, if this is the first fare being created for this feed, click `+ Create first fare` (highlighted in yellow).
 
 ![fare-tab](https://datatools-builds.s3.amazonaws.com/docs/fares/fare-tab.png)
 
 ### Edit fare attributes
-In the `Attributes` tab, required and optional information about the fare can be inputted, like `fare_id`, `price` and `currency_type`.
+In the `Attributes` tab, required and optional information about the fare can be entered, like `fare_id`, `price` and `currency_type`.
 
 **Note: Be sure to click the save button (💾) after changes to fare attributes or fare rules are made. Clicking save after adding attributes will allow you to edit fare rules.**
 
 ### Edit fare rules
 
-To define fare rules, you must first create fare zones, which is explained in the next section.
+To define fare rules, you must first create fare zones, which are explained in the next section.
 
 To edit fare rules, you must first create and save a fare with attributes. After choosing a fare, click the `Rules` tab and define one or more rules for this fare using the following types:
 

docs/user/editor/patterns.md

@@ -1,21 +1,21 @@
 # Trip Patterns
 
-### Patterns
+## Patterns
 Patterns refer to the recurring schedules and frequencies of transit trips. They can be thought of as a template for a particular route, indicating the days of the week and times of day that trips will be available, as well as the frequency of service during those periods.
 
 ## Editing/Creating Trip Patterns
 
-To begin editing trip patterns, first click the `Routes` tab (outlined in red). Then, select or create a route Click the `Trip patterns` tab, and start editing any relevant fields including: 
+To begin editing trip patterns, first click the `Routes` tab (outlined in red). Then, click or create a route Click the `Trip patterns` tab, and start editing any relevant fields including: 
 
 <!-- TODO: add transitwand to GTFS Editor -->
 <!-- - Transitwand id (optional) – the trip pattern can be imported from a Transitwand route trace, if you have one enter the phone id here and click the ‘Load from Transitwand’ box. -->
-- **Name:** the name of the pattern within the route, for example: "27 stops from Willowridge Rd at Richgrove Dr to Kipling Station (268 trips)"
-- **Type:** specify whether the pattern uses timetables or schedules. For more information on the differences between schedules and timetables, consult [Schedules](schedules.md)
-- **Direction:** specify whether the pattern is inbound or outbound. This corresponds to the `direction_id` field in GTFS. All trips associated with this pattern will be assigned the direction provided here.
+- **Name:** The name of the pattern within the route is initially set by default to a designation like "27 stops from Willowridge Rd at Richgrove Dr to Kipling Station (13 trips)." However, it can be customized to a more meaningful label if desired.
+- **Type:** Specifies whether the pattern uses timetables or schedules. For more information on the differences between schedules and timetables, consult [Schedules](schedules.md).
+- **Direction:** Specifies whether the pattern is inbound or outbound. This corresponds to the `direction_id` field in GTFS. All trips associated with this pattern will be assigned the direction provided here.
 - **Editing schedules:**
 Click `Edit schedules` to begin creating or editing trips/frequencies for a trip pattern. You will be redirected to the Schedule Editor. For more information on creating schedules for a pattern, see [Trips](schedules).
 
-To add a pattern, select the `+ New pattern` button (highlighted in yellow).
+To add a pattern, click the `+ New pattern` button (highlighted in yellow).
 
 ![edit-pattern](https://datatools-builds.s3.amazonaws.com/docs/patterns/edit-pattern.png)
 
@@ -27,17 +27,17 @@ The pattern toolbar contains several helpful buttons to help with the pattern ed
 - **Zoom to pattern extents:**
 Clicking the search (🔍) button (in the top toolbar) with a pattern selected adjusts the map view to show the entire pattern you are editing.
 - **Duplicating pattern:**
-Used to create a similar, but different trip pattern. When duplicating of the active pattern, it's name becomes `[Pattern name] copy`.
+Used to create a similar, but different trip pattern. When duplicating of the active pattern, its name becomes `[Pattern name] copy`.
 - **Reverse pattern:**
 To reverse the sequence of stops for a pattern, click the button with opposing arrows. Note: this is a destructive action and should usually only be used after duplicating a pattern.
 - **Delete pattern:** Deletes the active pattern. Note: deleted patterns cannot be recovered.
 
 
 ## Stop sequence
 ### Adding stops
-To start creating a pattern, click on the `+ Add stop` button. From here, zoom in on the map and add stops by clicking on them and clicking the green plus symbol: `+`. 
+To start creating a pattern, click the `+ Add stop` button. From here, zoom in on the map and add stops by clicking on them and clicking the green plus symbol: `+`. 
 
-Alternatively, scroll to the end of the stop sequence and select `+ Add stop by name` which will provide a dropdown of options to select from. From there, you'll have the option to add the stop to the end or to the beginning of the pattern.
+Alternatively, scroll to the end of the stop sequence and click `+ Add stop by name` which will provide a dropdown of options to click from. From there, you'll have the option to add the stop to the end or to the beginning of the pattern.
 
 <img src="https://datatools-builds.s3.amazonaws.com/docs/patterns/pattern-add-stop.png" style="box-shadow: 3px 3px 3px gray; border-radius: 10px;">
 
@@ -135,7 +135,7 @@ There are a few different editing modes that allow for the quick and easy creati
 - **Add stop at interval:** At each click on the map, stops are generated along the auto-generated pattern extended to the map click at the user-defined spacing interval from 100 to 2000 meters.
 - **Add stop at intersection:** (experimental, not available in all regions) - at each click on the map, stops are generated along the auto-generated pattern extended to the map click according to the user-defined parameters:
     - **Offset from intersection:** Distance the stop should be placed from the intersection
-    - **Before/after:** Whether stop should be placed before or after intersection
+    - **Before/after:** Whether the stop should be placed before or after intersection
     - **Every *n* intersections:** The number of intersections at which each new stop should be placed
 
 **Note**: the last three advanced editing modes should only be used when creating routes in new areas where stops don't already exist.

docs/user/editor/routes.md

@@ -38,7 +38,7 @@ The following fields are optional:
 - **Route branding URL:** A link to a webpage with route branding information
 - **Route branding asset:** A route image
 
-Once all the required fields, and any of the desired optional fields, are filled in click `Save`.
+Once all the required fields and any of the desired optional fields are filled in, click `Save`.
 
 **Note:** as with all newly created items (except patterns), the new route will not be saved until the save icon (💾) is clicked.