migrated all images and fixed most broken links

bcgov · Jan 12, 2024 · 1b79b09 · 1b79b09
1 parent 90bc5db
commit 1b79b09
Show file tree

Hide file tree

Showing 46 changed files with 45 additions and 43 deletions.
diff --git a/docs/About-CHEFS.md b/docs/About-CHEFS.md
@@ -1,4 +1,4 @@
-[Home](.) > **About CHEFS**
+[Home](index) > **About CHEFS**
 
 ---
 
@@ -96,4 +96,4 @@ You also can reach out to the CHEFS team directly at [[email protected]](
 
 Take a tour of CHEFS to see it in action. **(Youtube)**
 
-[![](https://github.com/bcgov/common-hosted-form-service/assets/87393930/ec61578b-4b21-41a4-bb69-743ccf3d7ad4)](https://youtu.be/obOhyYusMjM)
+<iframe width="560" height="315" src="https://www.youtube.com/embed/obOhyYusMjM?si=HEnwSYnd48BWTio8" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
diff --git a/docs/Advanced-Data.md b/docs/Advanced-Data.md
@@ -1,4 +1,4 @@
-[Home](.) > [CHEFS Components](CHEFS-Components) > [Form Builder Components](Form-Builder-Components) > **Advanced Data**
+[Home](index) > [CHEFS Components](CHEFS-Components) > [Form Builder Components](Form-Builder-Components) > **Advanced Data**
 ***
 
 | ![image](images/advanced_data.png) | Advanced data components are fields that manipulate the way Data is presented, saved, and organized. |

diff --git a/docs/Advanced-Fields.md b/docs/Advanced-Fields.md
@@ -1,4 +1,4 @@
-[Home](.) > [CHEFS Components](CHEFS-Components) > [Form Builder Components](Form-Builder-Components) > **Advanced Fields**
+[Home](index) > [CHEFS Components](CHEFS-Components) > [Form Builder Components](Form-Builder-Components) > **Advanced Fields**
 ***
 
 | ![image](images/advanced-fields.png) | Advanced Fields in form builders are an extension of Basic Fields, specifically designed to cater to more complex requirements. They offer additional features, functionality, or customization options beyond what the Basic Components provide |
@@ -376,7 +376,7 @@ Options Label Position: Determines the position of the option label relative to
 Inline Layout: Displays the option values horizontally
 </details>
 
-![image](https://github.com/bcgov/common-hosted-form-service/assets/87393930/5436bff6-90f1-4241-9adc-8e04a9412787)
+![image](images/advanced-radio.png)
 
 
 

diff --git a/docs/Advanced-Layout.md b/docs/Advanced-Layout.md
@@ -1,4 +1,4 @@
-[Home](.) > [CHEFS Components](CHEFS-Components) > [Form Builder Components](Form-Builder-Components) > **Advanced Layout**
+[Home](index) > [CHEFS Components](CHEFS-Components) > [Form Builder Components](Form-Builder-Components) > **Advanced Layout**
 ***
 
 | ![image](images/advanced-layout.png) | Layout components in form builders allow users to structure and organize the various elements of a form effectively. They serve distinct purposes in defining the layout and presentation of form fields. |

diff --git a/docs/Architecture-&-State-Management.md b/docs/Architecture-&-State-Management.md
@@ -1,4 +1,4 @@
-[Home](.) > [CHEFS Capabilities](CHEFS-Capabilities) > **Architecture & State Management**
+[Home](index) > [CHEFS Capabilities](CHEFS-Capabilities) > **Architecture & State Management**
 ***
 **Architecture**
 - [Infrastructure](#infrastructure)

diff --git a/docs/Autopopulating-Dropdown-Menus.md b/docs/Autopopulating-Dropdown-Menus.md
@@ -1,4 +1,4 @@
-[Home](.) > [CHEFS Components](CHEFS-Components) > [Custom Components](Custom-components) > **Autopopulating Dropdown Menus**
+[Home](index) > [CHEFS Components](CHEFS-Components) > [Custom Components](Custom-components) > **Autopopulating Dropdown Menus**
 ***
 
 ## Examples
@@ -37,7 +37,7 @@ This example uses JSON data from a BCGov github repo called [Ministry Org Names]
 | Enable Static Search| your choice    | checked                    |   
 
 For all other values use the defaults. If done correctly, the preview window will now show the JSON data in the select list drop-down.  
-![Screenshot 2023-07-10 at 11 35 34 AM](https://github.com/bcgov/common-hosted-form-service/assets/25111805/2236c1be-a2da-4e61-b752-a503ef544520)
+![img](images/auto-dropdown.png)
 
 ## Option 2 - Autopopulate a "Sector Name" Select field with the full list of sectors  
 ### Using a URL to a raw JSON file as the source for your "select" component dropdown menu values

diff --git a/docs/BC-Address-Component.md b/docs/BC-Address-Component.md
@@ -4,14 +4,14 @@ The BC Address component is a form.io custom component that autocompletes and su
 
 Drag and drop the 'BC Address' component into the form builder
 
-![bc1](https://user-images.githubusercontent.com/91633223/206018690-f3b19d3c-c5d9-4daf-8fc7-6a7a2ced35d4.png)
+![bc1](images/bc-add1.png)
 
 This is a preconfigured component. Please note that users can only change the 'Params' details as indicated in the following image. Please visit this link for more information: [Geocoder Developer Toolkit](https://bcgov.github.io/ols-devkit/examples/address_autocomplete.html)
 
-![bc2](https://user-images.githubusercontent.com/91633223/206019109-213eedff-7d23-4d43-b778-d3df4e51bfe1.png)
+![bc2](images/bc-add2.png)
 
 ## What it looks like
 
 BC Address component in preview mode: 
 
-![bc3](https://user-images.githubusercontent.com/91633223/206019188-4c853759-5a95-4600-b2d4-183ad854f72c.png)
+![bc3](images/bc-add3.png)
diff --git a/docs/BC-Government.md b/docs/BC-Government.md
@@ -1,4 +1,4 @@
-[Home](.) > [CHEFS Components](CHEFS-Components) > [Form Builder Components](Form-Builder-Components) > **BC Government**
+[Home](index) > [CHEFS Components](CHEFS-Components) > [Form Builder Components](Form-Builder-Components) > **BC Government**
 ***
 
 * [File Upload](#file-upload)

diff --git a/docs/Basic-Fields.md b/docs/Basic-Fields.md
@@ -1,4 +1,4 @@
-[Home](.) > [CHEFS Components](CHEFS-Components) > [Form Builder Components](Form-Builder-Components) > **Basic Fields**
+[Home](index) > [CHEFS Components](CHEFS-Components) > [Form Builder Components](Form-Builder-Components) > **Basic Fields**
 ***
 
 | ![image](images/basic-fields.png) | The basic fields in the Form Builder are commonly used in traditional web forms. You'll likely be familiar with these components if you've used a Form Builder before.  |

diff --git a/docs/Basic-Layout.md b/docs/Basic-Layout.md
@@ -1,4 +1,4 @@
-[Home](.) > [CHEFS Components](CHEFS-Components) > [Form Builder Components](Form-Builder-Components) > **Basic Layout**
+[Home](index) > [CHEFS Components](CHEFS-Components) > [Form Builder Components](Form-Builder-Components) > **Basic Layout**
 ***
 
 | ![image](images/basic_layout.png) | The Basic Layout includes commonly used form components such as Text/Images, Columns, Tabs, and Panels. It serves as a solid foundation for designing visually appealing and well-structured forms. |

diff --git a/docs/CHEFS-functionalities.md b/docs/CHEFS-functionalities.md
@@ -4,6 +4,7 @@
 ## Working with forms
 * [Importing and exporting form designs](Importing-and-exporting-form-designs)
 * [Schedule and Reminder notification](Schedule-and-Reminder-notification)
+* [Form Multilanguage](Form-Multilanguage)
 
 ## Working with submissions
 * [Printing from a browser](Printing-from-a-browser)

diff --git a/docs/Calculated-Values.md b/docs/Calculated-Values.md
@@ -1,4 +1,4 @@
-[Home](.) > [CHEFS Components](CHEFS-Components) > [Custom Components](Custom-components) > **Calculated Values**
+[Home](index) > [CHEFS Components](CHEFS-Components) > [Custom Components](Custom-components) > **Calculated Values**
 ***
 
 ## Examples 

diff --git a/docs/DevOps.md b/docs/DevOps.md
@@ -1,4 +1,4 @@
-[Home](.) > [Developer](Developer) > **DevOps**
+[Home](index) > [Developer](Developer) > **DevOps**
 ***
 
 Use the following pages to help you when doing DevOps for the CHEFS application.

diff --git a/docs/Developer-Additional-Resources.md b/docs/Developer-Additional-Resources.md
@@ -1,4 +1,4 @@
-[Home](.) > [Developer](Developer) > **Developer Additional Resources**
+[Home](index) > [Developer](Developer) > **Developer Additional Resources**
 ***
 
 # Common Services API Access

diff --git a/docs/Dynamic-Select-Lists.md b/docs/Dynamic-Select-Lists.md
@@ -1,4 +1,4 @@
-[Home](.) > [CHEFS Components](CHEFS-Components) > [Custom Components](Custom-components) > **Dynamic Select Lists**
+[Home](index) > [CHEFS Components](CHEFS-Components) > [Custom Components](Custom-components) > **Dynamic Select Lists**
 ***
 
 ## Examples

diff --git a/docs/Examples-of-CHEFS-forms-and-features.md b/docs/Examples-of-CHEFS-forms-and-features.md
@@ -1,4 +1,4 @@
-[Home](.) > [CHEFS Components](CHEFS-Components) > **Examples of CHEFS forms and features** 
+[Home](index) > [CHEFS Components](CHEFS-Components) > **Examples of CHEFS forms and features** 
 ***
 
 ## CHEFS forms in action

diff --git a/docs/Form-Builder-Components.md b/docs/Form-Builder-Components.md
@@ -1,4 +1,4 @@
-[Home](.) > [CHEFS Components](CHEFS-Components) > **Form Builder Components** 
+[Home](index) > [CHEFS Components](CHEFS-Components) > **Form Builder Components** 
 ***
 
 - [Basic Layout](Basic-Layout) 

diff --git a/docs/Form-Management.md b/docs/Form-Management.md
@@ -1,4 +1,4 @@
-[Home](.) > [CHEFS Capabilities](CHEFS-Capabilities) > **Form Management**
+[Home](index) > [CHEFS Capabilities](CHEFS-Capabilities) > **Form Management**
 ***
 
 - [Workflows and Statuses](Workflows-and-Statuses)

diff --git a/docs/Form-multilanguage.md b/docs/Form-multilanguage.md
@@ -1,4 +1,4 @@
-[Home](.) > [CHEFS Capabilities](CHEFS-Capabilities) > **Form Multilanguage**
+[Home](index) > [CHEFS Capabilities](CHEFS-Capabilities) > **Form Multilanguage**
 ***
 
 ## Internationalization
@@ -38,7 +38,7 @@
 <summary>Example</summary>
 The example below shows the CHEFS homepage in the English language, and after the language switch to the French language, it shows looks like in the French Language.
 
-![An example of text translated to French](https://github.com/bcgov/common-hosted-form-service/assets/14250649/a0f26b6c-ff16-4e93-be81-bcd8c5e9bdb4)
+![An example of text translated to French](images/fm-french.png)
 
 </details>
 
@@ -312,9 +312,9 @@ if(data.preventRedraw==="false") {
 <details>
 <summary>Example Screenshots</summary>
 
-![image of the form in design view](https://github.com/bcgov/common-hosted-form-service/assets/14250649/5d1c152a-6c80-4df1-b5db-ad8ebea20a43)
-![image of the published form in English](https://github.com/bcgov/common-hosted-form-service/assets/14250649/67e9d076-a1ee-4c1b-bb4d-ad069ef69e01)
-![image of the published form in French](https://github.com/bcgov/common-hosted-form-service/assets/14250649/d79f4273-a32d-4067-b2b4-1ec685212426)
+![image of the form in design view](images/fm1.png)
+![image of the published form in English](images/fm2.png)
+![image of the published form in French](images/fm3.png)
 </details>
 
 ## Languages Translation Model

diff --git a/docs/Form.io.md b/docs/Form.io.md
@@ -1,4 +1,4 @@
-[Home](.) > [Developer](Developer) > **Form.io**
+[Home](index) > [Developer](Developer) > **Form.io**
 ***
 
 * [Form.io validation](Form.io-validation)

diff --git a/docs/Integrations.md b/docs/Integrations.md
@@ -1,4 +1,4 @@
-[Home](.) > [CHEFS Capabilities](CHEFS-Capabilities) > **Integrations**
+[Home](index) > [CHEFS Capabilities](CHEFS-Capabilities) > **Integrations**
 ***
 
 * [Power BI Integration](Power-BI-Integration)

diff --git a/docs/Local-CHEFS-Instance-Setup.md b/docs/Local-CHEFS-Instance-Setup.md
@@ -1,4 +1,4 @@
-[Home](.) > [Developer](Developer) > [Contributors](Contributors) > **Local CHEFS Instance Setup**
+[Home](index) > [Developer](Developer) > [Contributors](Contributors) > **Local CHEFS Instance Setup**
 ***
 
 This document will help developers looking to install CHEFS on their local machines for testing and development. Following this documentation will set up an isolated sandbox CHEFS instance for investigation and research prior to preparing pull requests or code commits. 

diff --git a/docs/MS-Teams-Channel-Integration.md b/docs/MS-Teams-Channel-Integration.md
@@ -1,4 +1,4 @@
-[Home](.) > [CHEFS Capabilities](CHEFS-Capabilities) > [Integrations](Integrations) > **MS Teams Channel Integration** 
+[Home](index) > [CHEFS Capabilities](CHEFS-Capabilities) > [Integrations](Integrations) > **MS Teams Channel Integration** 
 ***  
 
 > This page describe how to add to an MS Teams Channel a form  built with https://Submit.digital.gov.bc.ca

diff --git a/docs/Product-Roadmap.md b/docs/Product-Roadmap.md
@@ -1,4 +1,4 @@
-[Home](.) > **Product Roadmap**
+[Home](index) > **Product Roadmap**
 ***
 
 ![img](images/product_roadmap.png)

diff --git a/docs/Restoring-a-deleted-submission.md b/docs/Restoring-a-deleted-submission.md
@@ -1,4 +1,4 @@
-[Home](.) > [CHEFS Capabilities](CHEFS-Capabilities) > [CHEFS functionalities](CHEFS-functionalities) > **Restoring a deleted submission**
+[Home](index) > [CHEFS Capabilities](CHEFS-Capabilities) > [CHEFS functionalities](CHEFS-functionalities) > **Restoring a deleted submission**
 ***
 
 

diff --git a/docs/Side-Menu-Buttons.md b/docs/Side-Menu-Buttons.md
@@ -1,17 +1,17 @@
 CHEFS features a new enhanced sidebar to simplify the form design process. Users may now navigate to the top and bottom of the form, preview, manage, and publish the form directly from the sidebar. 
 
-![side1](https://user-images.githubusercontent.com/91633223/203614803-4c51febd-b4bf-43b7-b453-0eb8639e1404.png)
+![side1](images/sm1.png)
 
 Only the ‘Top/Bottom’ navigation and ‘Collapse’ buttons are enabled by default with the other buttons being enabled as the form is populated. Once you add components to the form, the ‘Save’ button and ‘Undo/Redo’ functionality becomes enabled. 
 
-![side2](https://user-images.githubusercontent.com/91633223/203614827-12930576-08ea-49d3-b95e-55a833adbc98.png)
+![side2](images/sm2.png)
 
 The ‘Undo’ feature allows a user to revert changes until the most recent ‘Save’ point when the page is loaded, and the ‘Redo’ button until the most recent change to the form. This means that if the form builder page is reloaded after clicking ‘Save’, that will be the new form state and undo/redo will be disabled. After clicking ‘Save’, the ‘Preview’, ‘Manage’, and ‘Publish’ buttons are enabled. 
 
-![side3](https://user-images.githubusercontent.com/91633223/203614851-a9c921ad-6fcc-4290-b928-9dd539b78457.png)
+![side3](images/sm3.png)
 
 The ‘Preview’ button will preview the form as a submitter would see it, and the ‘Manage’ button will navigate to the ‘Manage Form’ dashboard where additional options are available to share the form and add team members with different roles. The ‘Publish’ button will also navigate to the 'Manage Form' dashboard but will prompt the user to confirm publishing the form, making it live. 
 
-![side4](https://user-images.githubusercontent.com/91633223/203614896-b810e776-a67d-4534-99f1-c0d97973d5cd.png)
+![side4](images/sm4.png)
 
 If a user clicks ‘Cancel’, they will automatically be redirected to the form builder page where they can continue working on the form. 
diff --git a/docs/SoAR-and-Compliance.md b/docs/SoAR-and-Compliance.md
@@ -1,4 +1,4 @@
-[Home](.) > [About CHEFS](About-CHEFS) > **SoAR and Compliance**
+[Home](index) > [About CHEFS](About-CHEFS) > **SoAR and Compliance**
 ***
 
 # SoAR and Compliance Procedures

diff --git a/docs/Submission-to-CSV-Export.md b/docs/Submission-to-CSV-Export.md
@@ -1,3 +1,4 @@
+<!-- This documentation provides a guide on how to design forms for the use cases mentioned below. It can be improved upon. The videos have not been migrated as they were not downloadable and this documentation is not referenced anywhere. -->
 **Note:** Nested grids (Components) such as Edit Grid, Data Grid, Container, etc., in your form will be converted to rows of data in submissions. 
 
 Template 1: When exporting your submission to CSV and you want these rows to be extracted (flattened) into multi rows in CSV, use this template. This template will backfill empty spaces in each row. See the video below:

diff --git a/docs/User-Comments-and-Monitoring.md b/docs/User-Comments-and-Monitoring.md
@@ -1,4 +1,4 @@
-[Home](.) > [About CHEFS](About-CHEFS) > **User Comments and Monitoring**
+[Home](index) > [About CHEFS](About-CHEFS) > **User Comments and Monitoring**
 ***
 
 The CHEFS team monitors comments from a variety of sources, where "comments" includes:

diff --git a/docs/View-my-submissions.md b/docs/View-my-submissions.md
@@ -1,14 +1,14 @@
 When viewing the submissions for a form, you can view the submissions that you submitted with your own account. This can be done by clicking on the checkbox for show my submissions when you're on the form submissions page.
 
 When you're on a form, click here to view submissions:
-![image](https://user-images.githubusercontent.com/101672465/203945857-ae29e5c9-21c5-409f-b8a3-247c821a52fe.png)
+![image](images/vs1.png)
 
 
 You should be able to see some submissions like this:
-<img width="932" alt="image" src="https://user-images.githubusercontent.com/101672465/203945273-4663e089-2c83-4303-96de-7664e9cef243.png">
+![image](images/vs2.png)
 
 Click on the Show my submissions checkbox:
-<img width="935" alt="image" src="https://user-images.githubusercontent.com/101672465/203945375-7a9a72a5-eaee-4456-82be-0a23d36854ed.png">
+![image](images/vs3.png)
 
 You'll then be presented with your own submissions.
-<img width="938" alt="image" src="https://user-images.githubusercontent.com/101672465/203945496-a96a64ad-7683-4cac-be06-219a246bccb7.png">
+![image](images/vs4.png)
diff --git a/docs/images/auto-dropdown.png b/docs/images/auto-dropdown.png
diff --git a/docs/images/bc-add1.png b/docs/images/bc-add1.png
diff --git a/docs/images/bc-add2.png b/docs/images/bc-add2.png
diff --git a/docs/images/bc-add3.png b/docs/images/bc-add3.png
diff --git a/docs/images/fm-french.png b/docs/images/fm-french.png
diff --git a/docs/images/fm1.png b/docs/images/fm1.png
diff --git a/docs/images/fm2.png b/docs/images/fm2.png
diff --git a/docs/images/fm3.png b/docs/images/fm3.png
diff --git a/docs/images/sm1.png b/docs/images/sm1.png
diff --git a/docs/images/sm2.png b/docs/images/sm2.png
diff --git a/docs/images/sm3.png b/docs/images/sm3.png
diff --git a/docs/images/sm4.png b/docs/images/sm4.png
diff --git a/docs/images/vs1.png b/docs/images/vs1.png
diff --git a/docs/images/vs2.png b/docs/images/vs2.png
diff --git a/docs/images/vs3.png b/docs/images/vs3.png
diff --git a/docs/images/vs4.png b/docs/images/vs4.png