Skip to content

Commit

Permalink
docs: intake changes guide
Browse files Browse the repository at this point in the history
  • Loading branch information
AntBush authored and ccbc-service-account committed Oct 4, 2024
1 parent e8e7cf6 commit 84b599a
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 0 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
- [SchemaSpy Database documentation](https://bcgov.github.io/CONN-CCBC-portal/schemaspy/)
- [Growthbook](#growthbook)
- [Metabase](#metabase)
- [Intake Updates Guide](docs/Necessary_changes_For_Intake_Update.md)

#### Local development

Expand Down
9 changes: 9 additions & 0 deletions docs/Necessary_changes_For_Intake_Update.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
In the application form, if there is a new intake with a new uiSchema the logic in lines 251-275 (Logic about intake number `if (ccbcIntakeNumber !== null && ccbcIntakeNumber <= 2) {`).

If a new jsonSchema (not UI schema) is to be used, don’t forget to import the jsonSchema to the DB by editing `importJsonSchemasToDb.ts`.

If future intakes have any special logic to submission (for example the rolling intake) then the dashboard.tsx page in the `applicantportal` folder is to be edited. Additionally, `index.tsx` in the `applicantportal` folder my need to be edited if the number of pages have changed (Lines 177-197 starting with `<h3>Application form overview</h3>`).

Most new intakes have a need to update the `ZoneMapWidget.tsx` file. This requires a new image usually submitted by the data team, and sometimes an update to the zone map URL. These URL constants can be found in `externalConstants.ts`.

Finally, new intakes must be included in the feature flag on growthbook. The feature flag “intake_zones_json” should be edited to include the new intake, along with a list of zones that are open for this intake.

0 comments on commit 84b599a

Please sign in to comment.