Merge pull request #14 from Dwigoric/patch-1

Patch 1
Dwigoric · Dec 25, 2023 · 7646269 · 7646269
2 parents 2abba42 + 8017fc8
commit 7646269
Show file tree

Hide file tree

Showing 58 changed files with 542 additions and 64 deletions.
diff --git a/.github/workflows/deployment_azure-app-service.yml b/.github/workflows/deployment_azure-app-service.yml
@@ -5,22 +5,21 @@ name: Deploy Node.js express app to Azure Web App - compact-donuts
 
 on:
   push:
+    paths-ignore:
+      - 'docs/**'
     branches:
       - main
-      - 'Sprint-[0-9]'
+      - 'Sprint-[0-9]*'
+      - 'patch-[0-9]*'
   workflow_dispatch:
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}
   cancel-in-progress: true
 
-env:
-  WRS_INSTANCE: docs/ucwa
-  WRS_ARTIFACT: webHelpUCWA2-all.zip
-  WRS_DOCKER_VERSION: 232.10165.1
-
 jobs:
   deploy:
+    name: Deploy to Azure Web App
     runs-on: ubuntu-latest
     environment:
       name: 'Production'
@@ -41,49 +40,15 @@ jobs:
           echo 'Install dependencies'
           yarn install --immutable
 
-      - name: Build jsdoc documentation
-        uses: andstor/jsdoc-action@v1
-        with:
-          source_dir: .
-          recurse: true
-          output_dir: ./public/docs/jsdoc
-
-      - name: Build Writerside docs using Docker
-        uses: JetBrains/writerside-github-action@v4
-        with:
-          instance: ${{ env.WRS_INSTANCE }}
-          artifact: ${{ env.WRS_ARTIFACT }}
-          docker-version: ${{ env.WRS_DOCKER_VERSION }}
-
-      - name: Upload Writerside documentation artifact
-        uses: actions/upload-artifact@v3
-        with:
-          name: wrs_docs
-          path: |
-              artifacts/${{ env.WRS_ARTIFACT }}
-              artifacts/report.json
-          retention-days: 7
-
-      - name: Test Writerside documentation
-        uses: JetBrains/writerside-checker-action@v1
-        with:
-          instance: ${{ env.WRS_INSTANCE }}
-
-      - name: Unzip Writerside artifact
-        uses: montudor/action-zip@v1
-        with:
-          args: unzip -qq artifacts/${{ env.WRS_ARTIFACT }} -d ./public/docs/code
-
-      - name: Remove unused files and folders
+      - name: Remove docs folder from repo
         run: |
-          sudo rm -rf artifacts
           git rm -rf docs 
 
       - name: 'Deploy to Azure Web App'
         uses: azure/webapps-deploy@v2
         id: deploy-to-webapp
         with:
-          app-name: 'unboundmnl-area-2-backend'
+          app-name: 'api-svfmc'
           slot-name: 'Production'
           publish-profile: ${{ secrets.AZURE_WEBAPP_PUBLISH_PROFILE }}
-          package: .
+          package: .
diff --git a/.github/workflows/docs-cf-pages-publish.yml b/.github/workflows/docs-cf-pages-publish.yml
@@ -0,0 +1,99 @@
+name: Publish Writerside and JSDoc documentation to Cloudflare Pages
+
+on:
+  push:
+    paths:
+        - 'docs/**'
+        - 'built_docs/**'
+    branches:
+      - main
+      - 'Sprint-[0-9]*'
+      - 'patch-[0-9]*'
+  workflow_dispatch:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  build:
+    name: Build documentation
+    runs-on: ubuntu-latest
+    env:
+      WRS_INSTANCE: docs/ucwa
+      WRS_ARTIFACT: webHelpUCWA2-all.zip
+      WRS_DOCKER_VERSION: 232.10275
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Build jsdoc documentation
+        uses: andstor/jsdoc-action@v1
+        with:
+          source_dir: .
+          recurse: true
+          output_dir: ./built_docs/jsdoc
+
+      - name: Build Writerside docs using Docker
+        uses: JetBrains/writerside-github-action@v4
+        with:
+          instance: ${{ env.WRS_INSTANCE }}
+          artifact: ${{ env.WRS_ARTIFACT }}
+          docker-version: ${{ env.WRS_DOCKER_VERSION }}
+
+      - name: Upload Writerside documentation artifact
+        uses: actions/upload-artifact@v3
+        with:
+          name: wrs_docs
+          path: |
+            artifacts/${{ env.WRS_ARTIFACT }}
+            artifacts/report.json
+          retention-days: 7
+
+      - name: Test Writerside documentation
+        uses: JetBrains/writerside-checker-action@v1
+        with:
+          instance: ${{ env.WRS_INSTANCE }}
+
+      - name: Unzip Writerside artifact
+        uses: montudor/action-zip@v1
+        with:
+          args: unzip -qq artifacts/${{ env.WRS_ARTIFACT }} -d ./built_docs/handbook
+
+      - name: Archive documentation
+        uses: actions/upload-artifact@v3
+        with:
+          name: docs
+          path: built_docs
+          retention-days: 7
+
+  deploy:
+    name: Publish to Cloudflare Pages
+    runs-on: ubuntu-latest
+    needs: build
+    env:
+      CLOUDFLARE_PAGES_PROJECT_NAME: 'docs-svfmc'
+    permissions:
+      contents: read
+      deployments: write
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Download documentation
+        uses: actions/download-artifact@v3
+        with:
+          name: docs
+          path: built_docs
+
+      - name: Publish to Cloudflare Pages
+        uses: cloudflare/pages-action@1
+        id: deploy-to-cloudflare-pages
+        with:
+          apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
+          accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
+          projectName: ${{ env.CLOUDFLARE_PAGES_PROJECT_NAME }}
+          directory: built_docs
+          gitHubToken: ${{ secrets.GITHUB_TOKEN }}
diff --git a/built_docs/_redirects b/built_docs/_redirects
@@ -0,0 +1 @@
+/ /handbook
diff --git a/docs/images/admin-officer-edit.png b/docs/images/admin-officer-edit.png
diff --git a/docs/images/admin-password-tab.png b/docs/images/admin-password-tab.png
diff --git a/docs/images/initial-deductions-toggle.png b/docs/images/initial-deductions-toggle.png
diff --git a/docs/images/interest-rate.png b/docs/images/interest-rate.png
diff --git a/docs/images/interest-toggle.png b/docs/images/interest-toggle.png
diff --git a/docs/images/loan-and-deposit-settings.png b/docs/images/loan-and-deposit-settings.png
diff --git a/docs/images/member-profile-create-btn.png b/docs/images/member-profile-create-btn.png
diff --git a/docs/images/member-profile-create-form.png b/docs/images/member-profile-create-form.png
diff --git a/docs/images/member-profile-delete-btn.png b/docs/images/member-profile-delete-btn.png
diff --git a/docs/images/member-profile-delete-confirm.png b/docs/images/member-profile-delete-confirm.png
diff --git a/docs/images/member-profile-deposits.png b/docs/images/member-profile-deposits.png
diff --git a/docs/images/member-profile-edit-btn.png b/docs/images/member-profile-edit-btn.png
diff --git a/docs/images/member-profile-edit-form.png b/docs/images/member-profile-edit-form.png
diff --git a/docs/images/member-profile-edit-success.png b/docs/images/member-profile-edit-success.png
diff --git a/docs/images/member-profile-loans.png b/docs/images/member-profile-loans.png
diff --git a/docs/images/member-profile-navigation.png b/docs/images/member-profile-navigation.png
diff --git a/docs/images/member-profile-submit-btn.png b/docs/images/member-profile-submit-btn.png
diff --git a/docs/images/member-profile-success.png b/docs/images/member-profile-success.png
diff --git a/docs/images/member-profile.png b/docs/images/member-profile.png
diff --git a/docs/images/notification-same-edit.png b/docs/images/notification-same-edit.png
diff --git a/docs/images/notification-settings.png b/docs/images/notification-settings.png
diff --git a/docs/images/officer-password-edit-btn.png b/docs/images/officer-password-edit-btn.png
diff --git a/docs/images/officer-password-edit.png b/docs/images/officer-password-edit.png
diff --git a/docs/images/officer-profile-create-btn.png b/docs/images/officer-profile-create-btn.png
diff --git a/docs/images/officer-profile-delete-btn.png b/docs/images/officer-profile-delete-btn.png
diff --git a/docs/images/officer-profile-delete-confirm.png b/docs/images/officer-profile-delete-confirm.png
diff --git a/docs/images/officer-profile-form.png b/docs/images/officer-profile-form.png
diff --git a/docs/images/officer-profile-navigation.png b/docs/images/officer-profile-navigation.png
diff --git a/docs/images/officer-profile-success.png b/docs/images/officer-profile-success.png
diff --git a/docs/images/password-length.png b/docs/images/password-length.png
diff --git a/docs/images/password-requirements.png b/docs/images/password-requirements.png
diff --git a/docs/topics/Adding-Deposit-Ledger-Transaction.md b/docs/topics/Adding-Deposit-Ledger-Transaction.md
@@ -1,3 +1,5 @@
 # Adding Deposit Ledger Transaction
 
-Start typing here...
+To add a deposit transaction, click the ___Add New Transaction___ button found at the bottom of the deposit ledger. 
+
+From there, fill in the fields. Click on the ___Submit___ button when you are done, and it will immediately be reflected to the system.
diff --git a/docs/topics/Adding-Loan-Ledger-Transaction.md b/docs/topics/Adding-Loan-Ledger-Transaction.md
@@ -1,3 +1,13 @@
 # Adding Loan Ledger Transaction
 
-Start typing here...
+To add a loan transaction, click the ___Add New Transaction___ button found at the bottom of the loan ledger. If the ___Add New Transaction___ button cannot be pressed, that could be due to the fact the loan has not been released.
+
+From there, you can pick whether you are encoding a:
+- Payment
+  - To deduct from your outstanding balance.
+- Dues
+  - To add from your outstanding balance.
+- Balance Readjustment
+  - Purely for editing and readjusting the loanee's balance.
+
+Once you are done with the transaction, simply click the __submit__ button to submit it to the database, and it will be instantly reflected to the ledger.
diff --git a/docs/topics/Admin.md b/docs/topics/Admin.md
@@ -1,5 +1,11 @@
 # Admin
 
+The Admin is the most powerful user of the application. They
+oversee the officer accounts and the settings of the loans and deposits. 
+The admin has the liberty to create, delete, and change the passwords of the officer profiles.
+The admin also has the same permissions as the officers in member creation and management alongside
+the loan and deposit functionalities. 
+
 <seealso>
     <category ref="admin">
         <a href="Changing-Password.md" />

diff --git a/docs/topics/Changing-Password.md b/docs/topics/Changing-Password.md
@@ -1,5 +1,26 @@
 # Changing Password
 
+Changing a password is a fundamental feature for the security of the website especially considering that the website houses the personal information of the cooperative's members. 
+
+Accordingly, the admin is able to change their own password as well as the passwords of the officers.
+
+The admin is able to change their own password in the dedicated tab.
+
+<img src="admin-password-tab.png" alt="Changing password screenshot" />
+
+The passwords of the officers can be changed in the edit officer profile option in the officer profiles tab. 
+
+<img src="admin-officer-edit.png" alt="Changing password screenshot" />
+
+To ensure a secure password, the initial password of a newly created officer profile alongside any new passwords for both the admin and any officer profile will have certain requirements, namely: A capital letter, a lowercase letter, a number, and a special character.
+
+<img src="password-requirements.png" alt="Changing password screenshot" />
+
+It must also be at minimum 8 characters. 
+
+<img src="password-length.png" alt="Changing password screenshot" />
+
+Once the password has been changed, upon logging out, the new password will be in effect and will be used to log back in to the specific profile or the admin itself. 
 <seealso>
     <category ref="admin">
         <a href="Loan-and-Deposit-Settings.md" />

diff --git a/docs/topics/Creating-New-Deposit.md b/docs/topics/Creating-New-Deposit.md
@@ -1,5 +1,27 @@
 # Creating New Deposit
 
+When creating a deposit application, you do not need to fill out all the fields.
+The fields related to the member's information are required, but their information will be retrieved when you search for their profile.
+
+<procedure title="Creating a loan application" type="steps">
+<step>
+Search for a member by their name or username.
+</step>
+<step>
+Click on the member's name to select them, or press
+Enter or tab.
+<img src="member-search-result.png" alt="Member search result" />
+</step>
+<step>
+Fill out the loan application form.
+</step>
+<step>
+Click on the <strong>Submit</strong> button to submit the deposit application.
+</step>
+</procedure>
+
+Deposits do not need any approval, hence they are immediately reflected to the system once submitted.
+
 <seealso>
     <category ref="deposits">
         <a href="Deposit-Dashboard.md" />

diff --git a/docs/topics/Creating-a-Loan-Application.md b/docs/topics/Creating-a-Loan-Application.md
@@ -4,6 +4,10 @@ When creating a loan application, you do not need to fill out all the fields.
 The fields related to the member's information are required, but their information
 will be retrieved when you search for their profile.
 
+> You must [set up the Loan Application Form PDF](Server-Set-up-the-Loan-Application-Form-PDF.md)
+> on the server before proceeding, if you haven't already.
+{ style='warning' }
+
 <procedure title="Creating a loan application" type="steps">
 <step>
 Search for a member by their name or username.
@@ -42,6 +46,7 @@ You can find instructions on how to approve or reject a loan application at
     <category ref="loans">
         <a href="Loan-Dashboard.md" />
         <a href="Loan-Approval-Rejection.md" />
+        <a href="Loan-Ledger.md" />
     </category>
     <category ref="uh">
         <a href="Admin.md" />
@@ -57,3 +62,4 @@ You can find instructions on how to approve or reject a loan application at
         <a href="Vue.md"></a>
     </category>
 </seealso>
+
diff --git a/docs/topics/Deposit-Dashboard.md b/docs/topics/Deposit-Dashboard.md
@@ -1,5 +1,25 @@
 # Deposit Dashboard
 
+Present in the __Deposit Dashboard__ page are all the loans present in the system.
+
+Each row contains information on a certain deposit. Information present are as follows:
+- Deposit Category
+  - This can be categorized as:
+    - Share Capital
+    - Savings
+    - Time Deposit
+- Deposit Holder; A button that can forward the user to the deposit holder's profile.
+- Approval Date
+
+## Sorting, Filtering, and Searching
+
+Deposits are not sorted in any order, but it is possible to add you own sort. Adding your own sort can be done by clicking the header of the certain field you would like to toggle. An arrow would then appear, pointing up for ascending, and pointing down for descending. Clicking the header once again would remove the sorting of that specific header. Additionally, the search bar found on the top left of the deposits table can help filter specific fields you wish to search.
+
+## Accessing the Deposit Ledger
+
+To access the deposit ledger of a specific deposit, find the deposit to view, navigate to the right most part of the deposit's row and find the arrow. This will forward you to the deposit's ledger page.
+
+
 <seealso>
     <category ref="deposits">
         <a href="Creating-New-Deposit.md" />

diff --git a/docs/topics/Deposit-Ledger.md b/docs/topics/Deposit-Ledger.md
@@ -1,3 +1,29 @@
 # Deposit Ledger
 
-Start typing here...
+The loan ledger can be accessed through:
+
+*  The [Deposit Dashboard](Deposit-Dashboard.md)
+*  Respective [Member Profile](Member-Profiles.md)
+
+The full contents of a deposit can be found in this page as well. The contents are as follows:
+- Running Amount
+- Deposit ID
+- Type of Deposit
+  - This can be categorized into:
+    - Share Capital
+    - Savings
+    - Time Deposit
+- Date of Deposit
+
+Below the loan info is the actual loan ledger. Per row, the information are as follows:
+- Date of Payment
+- GV/OR Number
+- Transaction Type
+  - This can be categorized into
+    - Deposit
+    - Withdrawal
+- Amount
+- Interest
+- Balance   
+- Date of Entry
+- Officer in Charge
diff --git a/docs/topics/Deposits.md b/docs/topics/Deposits.md
@@ -1,5 +1,10 @@
 # Deposits
 
+Loans can be viewed in two different ways:
+* Through the [Deposit Dashboard](Deposit-Dashboard.md), which contains all deposits in the system
+present in the system
+* Through a [member's profile](Member-Profiles.md), which contains all deposits of that specific member.
+
 <seealso>
     <category ref="deposits">
         <a href="Deposit-Dashboard.md" />

diff --git a/docs/topics/Loan-Approval-Rejection.md b/docs/topics/Loan-Approval-Rejection.md
@@ -32,6 +32,7 @@ Its status will now be changed to <strong>Approved (for release)</strong>.
     <category ref="loans">
         <a href="Loan-Dashboard.md" />
         <a href="Creating-a-Loan-Application.md" />
+        <a href="Loan-Ledger.md" />
     </category>
     <category ref="uh">
         <a href="Admin.md" />
@@ -47,3 +48,4 @@ Its status will now be changed to <strong>Approved (for release)</strong>.
         <a href="Vue.md"></a>
     </category>
 </seealso>
+