GITBOOK-18: No subject

docs/SUMMARY.md

@@ -2,16 +2,17 @@
 
 * [Welcome to Uptime Manager](README.md)
 
-## Group 1
+## USER'S GUIDE
 
-* [Installing Uptime Manager](group-1/quickstart.md)
-* [Using Uptime Manager](group-1/using-uptime-manager.md)
-* [Creating a new monitor](group-1/creating-a-new-monitor.md)
-* [Page 1](group-1/page-1.md)
-* [Pagespeed monitoring](group-1/pagespeed-monitoring.md)
+* [Installing Uptime Manager](users-guide/quickstart.md)
+* [Using Uptime Manager](users-guide/using-uptime-manager.md)
+* [Creating a new monitor](users-guide/creating-a-new-monitor.md)
+* [Pagespeed monitoring](users-guide/pagespeed-monitoring.md)
+* [Incidents page](users-guide/incidents-page.md)
+* [Server settings](users-guide/server-settings.md)
+* [User settings](users-guide/user-settings.md)
 
-***
+## DEVELOPER'S GUIDE
 
-* [Incidents page](incidents-page.md)
-* [Server settings](server-settings.md)
-* [User settings](user-settings.md)
+* [Contributing to the code](developers-guide/contributing-to-the-code.md)
+* [General project structure](developers-guide/general-project-structure.md)

docs/developers-guide/contributing-to-the-code.md

@@ -0,0 +1,14 @@
+# Contributing to the code
+
+We generally follow the [gitflow](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow) workflow model.  If you’re not familiar with it, the general steps are
+
+1. Create a feature branch in your local depository and make your changes.
+2. Push your branch to the remote repository on Github.
+3. Open a pull request.
+4. The rest of the team will review the pull request and either approve or request changes.
+5. If changes are requested, make changes and push.
+6. Project maintainer will merge the branch, closing the pull request and deleting the remote branch.
+
+### Git
+
+If you are inexperienced with Git or need a refresher please visit our [Git Quick Start Guide](https://github.com/ajhollid/bluewave\_collaborative\_git) to help get up to speed.  If you’d like to go further in depth, this [Git for Professionals](https://youtu.be/Uszj\_k0DGsg?si=6rOWEQOMxmwhnb-K) is a good resource.\

docs/developers-guide/general-project-structure.md

@@ -0,0 +1,44 @@
+# General project structure
+
+The Uptime Manager product uses the MERN stack, which is to say that the project uses:
+
+* React on the Front End via Vite
+* Express on the Back End via NodeJS
+* MongoDB for data with Mongoose for data access
+
+### Front end
+
+The project uses the [Material UI Components](https://mui.com/material-ui/all-components/) (MUI) which allows us to build with a minimum of fuss.  The library is highly customisable and the project makes heavy use of the Theme concept and follows MUI’s paradigm to avoid writing excessive CSS.\
+\
+The overriding goal on the Front Eed is to write maintainable and scalable code.  If you find yourself writing lots of CSS to customize a component or are having to set a value often like font size or color you probably should be using the theme.\
+\
+When making changes to the Front end please always keep future developers in mind.  Will they know how to make changes to your code?  Is your code modular?  If a dev makes changes elsewhere in the app will your component be affected?  If the team makes a theme change like font size or primary color will your component be updated as well? 
+
+### Back end
+
+The back end of this project is not especially complex and is built around Express.  The back end is a RESTful API and the [documentation can be found here](https://uptime-demo.bluewavelabs.ca/api-docs).
+
+The application consists of several main conceptual models:
+
+1. User
+2. Monitor
+3. Check
+4. Notification
+
+There are several supporting models as well.
+
+1. AppSettings
+2. InviteToken
+3. Team
+
+All requests are based around these models and manipulation of their data.\
+\
+In general the models interact in this fashion:
+
+* A `User` has many `Monitors`
+* A `Monitor` has many `Checks`
+* A `Monitor` has many `Notifications`
+
+A `User` can create a `Monitor`.  `Monitors` are enqueued in the `JobQueue`, and their target URLs are queried when they are dequeued.  When the query is complete, a `Check` is created that records information about the request.\
+\
+A `User` may attach a `Notification` to their `Monitor`, if the `Monitor`’s status changes then the user will be notified by the method specified in the `Notification`

docs/group-1/page-1.md

@@ -1,2 +0,0 @@
-# Page 1
-

docs/users-guide/incidents-page.md

@@ -6,7 +6,7 @@ icon: brake-warning
 
 This page shows a list of incidents of all the servers you monitor. 
 
-<figure><img src=".gitbook/assets/Screenshot 2024-10-03 at 11.54.31 PM.png" alt=""><figcaption></figcaption></figure>
+<figure><img src="../.gitbook/assets/Screenshot 2024-10-03 at 11.54.31 PM.png" alt=""><figcaption></figcaption></figure>
 
 Page includes a table where Monitor name, Status (down or cannot resolve), date and time of the incident, status code and corresponding message is shown.
 

docs/users-guide/user-settings.md

@@ -8,7 +8,7 @@ This screen allows you to manage your personal information and account settings
 
 ### Profile section
 
-<figure><img src=".gitbook/assets/Screenshot 2024-10-04 at 12.17.57 AM.png" alt=""><figcaption></figcaption></figure>
+<figure><img src="../.gitbook/assets/Screenshot 2024-10-04 at 12.17.57 AM.png" alt=""><figcaption></figcaption></figure>
 
 Enter your first name, last name and email here. You can also upload or delete a profile photo. If you want to delete an account, this can also be done here. Note that that this is irreversible and cannot be undone.
 
@@ -16,7 +16,7 @@ Enter your first name, last name and email here. You can also upload or delete a
 
 This screen allows you to update your password for your account.
 
-<figure><img src=".gitbook/assets/Screenshot 2024-10-04 at 12.16.53 AM.png" alt=""><figcaption></figcaption></figure>
+<figure><img src="../.gitbook/assets/Screenshot 2024-10-04 at 12.16.53 AM.png" alt=""><figcaption></figcaption></figure>
 
 In order to change your password, you need to enter your password, and the new password twice. The new password must meet the specified criteria (e.g., minimum length, uppercase letter, number, symbol).
 
@@ -29,7 +29,7 @@ In order to change your password, you need to enter your password, and the new p
 
 This screen allows you to manage your team members within the application.
 
-<figure><img src=".gitbook/assets/Screenshot 2024-10-04 at 12.14.45 AM.png" alt=""><figcaption></figcaption></figure>
+<figure><img src="../.gitbook/assets/Screenshot 2024-10-04 at 12.14.45 AM.png" alt=""><figcaption></figcaption></figure>
 
 Here you can see a list of all users in your system. A user can be either admin or a member, where an admin can create or delete a monitor, and a user can only view them.&#x20;
 

docs/users-guide/using-uptime-manager.md

@@ -1,8 +1,8 @@
 ---
-icon: computer-mouse
 description: >-
   This user guide helps new users navigate and understand the Uptime Manager
   dashboard layout and functionality.
+icon: computer-mouse
 ---
 
 # Using Uptime Manager