Post workshop updates to documentation

BenBowers · Jun 25, 2024 · ed0282f · ed0282f
1 parent 5472c85
commit ed0282f
Show file tree

Hide file tree

Showing 13 changed files with 37 additions and 32 deletions.
diff --git a/docs/docs/borrower-profile/_category_.json b/docs/docs/borrower-profile/_category_.json
@@ -5,6 +5,6 @@
   "collapsed": false,
   "link": {
     "type": "generated-index",
-    "title": "Borrowing Capacity"
+    "title": "Borrower Profile"
   }
 }
diff --git a/docs/docs/borrower-profile/explore-api.mdx b/docs/docs/borrower-profile/explore-api.mdx
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 1
+sidebar_position: 3
 tags:
   - explore-borrower-profile-api
 ---

diff --git a/docs/docs/borrower-profile/overview.mdx b/docs/docs/borrower-profile/overview.mdx
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 3
+sidebar_position: 1
 tags:
   - borrower-profile
 ---
@@ -26,9 +26,12 @@ sequenceDiagram
     participant PrimaryAdaptor as API GW: Create Borrower Profile
     participant CreateBorrowerProfileUseCase as Create Borrower Profile Use Case
     participant PutBorrowerProfileSecondaryAdapter as DynamoDB: Put Borrower Profile
+    participant GetBorrowerProfileSecondaryAdapter as DynamoDB: Get Borrower Profile
     
     User->>+PrimaryAdaptor: Submit Borrower Profile Data
     PrimaryAdaptor->>+CreateBorrowerProfileUseCase: Validate & Forward Data
+    CreateBorrowerProfileUseCase->>+GetBorrowerProfileSecondaryAdapter: Get Borrower Profile
+    GetBorrowerProfileSecondaryAdapter-->>-CreateBorrowerProfileUseCase: undefined
     CreateBorrowerProfileUseCase->>+PutBorrowerProfileSecondaryAdapter: Store Borrower Profile Information
     PutBorrowerProfileSecondaryAdapter-->>-CreateBorrowerProfileUseCase: Confirmation
     CreateBorrowerProfileUseCase-->>-PrimaryAdaptor: Confirmation

diff --git a/docs/docs/borrowing-capacity/explore-api.mdx b/docs/docs/borrowing-capacity/explore-api.mdx
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 1
+sidebar_position: 3
 tags:
   - borrowing-capacity overview
 ---

diff --git a/docs/docs/borrowing-capacity/overview.mdx b/docs/docs/borrowing-capacity/overview.mdx
@@ -1,10 +1,10 @@
 ---
-sidebar_position: 3
+sidebar_position: 1
 tags:
   - borrowing-capacity overview
 ---
 
-# Borrowing Capacity
+# Overview
 
 ![Calculate Borrower's Borrowing Capacity](/img/borrowing-capacity/calculate-borrowers-borrowing-capacity.svg)
 
@@ -111,7 +111,7 @@ sequenceDiagram
     CalculateBorrowingCapacityUseCase-->>CalculateBorrowingCapacityUseCase: Calculate Borrowing Capacity
     CalculateBorrowingCapacityUseCase->>+PutBorrowingCapacityCalculationSecondaryAdaptor: Put Borrowing Capacity Calculation 
     PutBorrowingCapacityCalculationSecondaryAdaptor-->>-CalculateBorrowingCapacityUseCase: throws InternalError
-    CalculateBorrowingCapacityUseCase-->>-PrimaryAdaptor: throws InternalServerError
+    CalculateBorrowingCapacityUseCase-->>-PrimaryAdaptor: throws InternalError
     PrimaryAdaptor-->>-User: {statusCode: 500, message: "Internal Server Error"}
 ```
 ### Borrower Profile Could Not Be Retrieved (500)

diff --git a/docs/docs/deployment.mdx b/docs/docs/deployment.mdx
@@ -6,12 +6,20 @@ tags:
 
 # Deployment
 
-## Install dependencies
+## Checkout the workshop branch
 
 1. Open a __new__ terminal
 
 2. In the __new__ terminal, run the following:
 
+  ```shell
+  git checkout workshop-start
+  ```
+
+## Install dependencies
+
+1. In the same terminal, run the following:
+
   ```shell
   pnpm i
   ```

diff --git a/docs/docs/loan-application/overview.mdx b/docs/docs/loan-application/overview.mdx
@@ -8,24 +8,14 @@ tags:
 
 ## Stories
 
-## Create a profile
+## Create a borrower profile
 
-```mermaid
-timeline
-  Collect Borrower Details: D.O.B, Name, Credit Score, Email Address
-  Create Borrower Profile: Borrower Profile Persisted
-```
+![Create a borrower profile story](/img/borrower/create-borrower-profile-story.svg)
 
 ## Apply for a loan
 
-```mermaid
-timeline
-    Get Borrower Profile : Look up Borrower Profile w/ Email Address
-    Collect Additional Information: Employment Status, Gross Annual Income, Monthly Expenses   
-    Calculate Borrower's Age: Use D.O.B. from Borrower's profile.
-    Asses Loan Application: Uses Age,Employment Status, Gross Annual Income, Monthly E
-    Create Loan Application: Loan Application Persisted
-```
+![Apply for a loan story](/img/loan-application/apply-for-loan-story.svg)
+
 
 1. User initiates a request to apply for a loan through a client application.
 2. The request is received by the primary adaptor: `api-gw-apply-for-loan`.
@@ -124,7 +114,7 @@ sequenceDiagram
     ApplyForLoanUseCase-->>ApplyForLoanUseCase: Assess Loan Application 
     ApplyForLoanUseCase->>+PutLoanApplicationSecondaryAdaptor: Put Loan Application 
     PutLoanApplicationSecondaryAdaptor-->>-ApplyForLoanUseCase: throws InternalError
-    ApplyForLoanUseCase-->>-PrimaryAdaptor: throws InternalServerError
+    ApplyForLoanUseCase-->>-PrimaryAdaptor: throws InternalError
     PrimaryAdaptor-->>-User: {statusCode: 500, message: Internal Server Error}
 ```
 
@@ -142,6 +132,6 @@ sequenceDiagram
     PrimaryAdaptor->>+ApplyForLoanUseCase: Validate & Forward Request
     ApplyForLoanUseCase->>+GetBorrowerProfileSecondaryAdapter: Get Borrower Profile 
     GetBorrowerProfileSecondaryAdapter-->>-ApplyForLoanUseCase: throws BorrowerProfileDoesNotExistError
-    ApplyForLoanUseCase-->>-PrimaryAdaptor: throws InternalServerError
+    ApplyForLoanUseCase-->>-PrimaryAdaptor: throws InternalError
     PrimaryAdaptor-->>-User: {statusCode: 400, message: 'Borrower with the provided email does not exist'}
 ```
diff --git a/docs/docs/loan-application/workshop-activities/integration.mdx b/docs/docs/loan-application/workshop-activities/integration.mdx
@@ -103,7 +103,7 @@ describe.concurrent('api-aw-apply-for-loan', () => {
 });
 ```
 
-## Scenario 3
+## New Loan Application Created (201)
 
 Finally we want to test the successful case. To do this we create a borrower using another api and then POST the loan api with a borrower with the same email address
 

diff --git a/docs/docs/loan-application/workshop-activities/secondary-adapter.mdx b/docs/docs/loan-application/workshop-activities/secondary-adapter.mdx
@@ -220,6 +220,7 @@ describe('ddb-put-loan-application', () => {
         sk:
           `LOAN_APPLICATION#${loanApplication.loanApplicationId}` +
           `#TIMESTAMP#${loanApplication.timestamp}`,
+        borrowerEmail: loanApplication.borrowerEmail,
         loanApplicationId: loanApplication.loanApplicationId,
         timestamp: loanApplication.timestamp,
         creditScore: loanApplication.creditScore,
@@ -290,6 +291,7 @@ export const putLoanApplication: PutLoanApplicationPort = async ({
       Item: marshall({
         pk: borrowerEmail,
         sk: `LOAN_APPLICATION#${loanApplicationId}#TIMESTAMP#${timestamp}`,
+        borrowerEmail,
         loanApplicationId,
         timestamp,
         creditScore,

diff --git a/docs/docs/stories.mdx b/docs/docs/stories.mdx
@@ -6,11 +6,10 @@ tags:
 
 # Stories
 
-## Create a profile
+## Create a borrower profile
 
-![Borrower Stories](/img/borrower/create-a-borrower-profile-story.svg)
+![Create a borrower profile story](/img/borrower/create-borrower-profile-story.svg)
 
 ## Get an indication of my borrowing capacity
 
-
-![Borrowing Capacity Stories](/img/borrowing-capacity/borrowing-capacity-story.svg)
+![Get an indication of my borrowing capacity story](/img/borrowing-capacity/borrowing-capacity-story.svg)
diff --git a/docs/static/img/borrower/create-a-borrower-profile-story.svg b/docs/static/img/borrower/create-a-borrower-profile-story.svg
-Original file line number
+Diff line change
@@ Expand Up / @@ -103,7 +103,7 @@ describe.concurrent('api-aw-apply-for-loan', () => { @@
     });
     ```
-    ## Scenario 3
+    ## New Loan Application Created (201)
     Finally we want to test the successful case. To do this we create a borrower using another api and then POST the loan api with a borrower with the same email address
@@ Expand Down @@