Skip to content

Commit

Permalink
docs(config): necessary templates for new agencies
Browse files Browse the repository at this point in the history
  • Loading branch information
machikoyasuda committed Dec 20, 2023
1 parent 025f5a6 commit 39dae9e
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions docs/configuration/transit-agency.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,15 @@ Note that a `TransitAgency` model requires:
- a `PaymentProcessor` for enrolling the user's contactless card for discounts
- an `info_url` and `phone` for users to contact customer service
- an SVG or PNG file of the transit agency's logo
- HTML templates for various buttons, text and other user interface elements of the flow, including:
- `index_template`: _Required for agencies_ - Text for agency direct entry page
- `eligibility_index_template`: _Required for agencies_ - Text for Eligibility Index page
- `enrollment_success_template`: _Required for agencies_ - Text for Enrollment Success page
- `help_template`: _Required for agencies_ - Agency-specific help questions and answers
- `selection_label_template`: _Required for verifiers_ - Text and optional modals for the radio button form on the Eligibility Index page
- `start_template`: _Required for verifiers_ - Text and optional custom styles for call to action button on the Eligibility Start page
- `sign_out_button_template`: _Required for auth providers_ - Sign out link button, used on any page after sign in
- `sign_out_link_template`: _Required for auth providers_ - Sign out link text, used on any page after sign in

Also note that these steps assume the transit agency is using Littlepay as their payment processor. Support for integration with [other payment processors](https://www.camobilitymarketplace.org/contracts/) may be added in the future.

Expand Down

0 comments on commit 39dae9e

Please sign in to comment.