diff --git a/docs/.gitbook/assets/Screenshot 2024-10-04 at 9.28.27 AM.png b/docs/.gitbook/assets/Screenshot 2024-10-04 at 9.28.27 AM.png new file mode 100644 index 000000000..97a73e3a8 Binary files /dev/null and b/docs/.gitbook/assets/Screenshot 2024-10-04 at 9.28.27 AM.png differ diff --git a/docs/.gitbook/assets/Screenshot 2024-10-04 at 9.30.30 AM.png b/docs/.gitbook/assets/Screenshot 2024-10-04 at 9.30.30 AM.png new file mode 100644 index 000000000..94e872cdb Binary files /dev/null and b/docs/.gitbook/assets/Screenshot 2024-10-04 at 9.30.30 AM.png differ diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index e50c1b392..fc20c5679 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -4,15 +4,16 @@ ## USER'S GUIDE -* [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) +* [Installing Uptime Manager](quickstart.md) +* [Using Uptime Manager](using-uptime-manager.md) +* [Creating a new monitor](creating-a-new-monitor.md) +* [Pagespeed monitoring](pagespeed-monitoring.md) +* [Incidents page](incidents-page.md) +* [Server settings](server-settings.md) +* [User settings](user-settings.md) ## DEVELOPER'S GUIDE * [Contributing to the code](developers-guide/contributing-to-the-code.md) * [General project structure](developers-guide/general-project-structure.md) +* [High level overview](developers-guide/high-level-overview.md) diff --git a/docs/users-guide/creating-a-new-monitor.md b/docs/creating-a-new-monitor.md similarity index 100% rename from docs/users-guide/creating-a-new-monitor.md rename to docs/creating-a-new-monitor.md diff --git a/docs/developers-guide/high-level-overview.md b/docs/developers-guide/high-level-overview.md new file mode 100644 index 000000000..070558741 --- /dev/null +++ b/docs/developers-guide/high-level-overview.md @@ -0,0 +1,27 @@ +# High level overview + + + +The figure below shows a high level architecture of the Uptime Manager. + +
+ +### Typical auth request overview + +The following diagram describes a typical request to the /auth endpoints. + +
+ +### Typical monitor request overview + +The following diagram describes a typical request to the `/monitors` endpoints. + + + + + +\ +\ + + +\ diff --git a/docs/users-guide/incidents-page.md b/docs/incidents-page.md similarity index 77% rename from docs/users-guide/incidents-page.md rename to docs/incidents-page.md index 988290d37..6aee277bf 100644 --- a/docs/users-guide/incidents-page.md +++ b/docs/incidents-page.md @@ -6,7 +6,7 @@ icon: brake-warning This page shows a list of incidents of all the servers you monitor. -
+
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. diff --git a/docs/users-guide/pagespeed-monitoring.md b/docs/pagespeed-monitoring.md similarity index 89% rename from docs/users-guide/pagespeed-monitoring.md rename to docs/pagespeed-monitoring.md index 260e1c30c..bbbd28b52 100644 --- a/docs/users-guide/pagespeed-monitoring.md +++ b/docs/pagespeed-monitoring.md @@ -6,7 +6,7 @@ icon: gauge-min Under Dashboard > Pagespeed, you can see an overview of pagespeed monitors for different websites. This dashboard helps you view optimal website performance by providing clear, actionable insights into various aspects of your site's speed and user experience. -
+
When you add a new page speed monitor, it is added here. Click on the "Create new" button to add a new page speed. @@ -14,7 +14,7 @@ Here, both monitors are shown as "Live (Collecting Data)" with a green dot, indi ### Details of a pagespeed monitor -
+
When you click on a pagespeed card, you'll see an overview of data collected using Google's PageSpeed Monitor API. @@ -45,7 +45,7 @@ You'll see an overall score of your server's pagespeed. When you are on a pagespeed screen, click on the "Create pagespeed" button. You'll see a screen similar to this: -
+
This page allows you to set up a new pagespeed monitor for your website. Follow these steps to configure your monitor: diff --git a/docs/users-guide/quickstart.md b/docs/quickstart.md similarity index 100% rename from docs/users-guide/quickstart.md rename to docs/quickstart.md diff --git a/docs/users-guide/server-settings.md b/docs/server-settings.md similarity index 100% rename from docs/users-guide/server-settings.md rename to docs/server-settings.md diff --git a/docs/users-guide/user-settings.md b/docs/user-settings.md similarity index 80% rename from docs/users-guide/user-settings.md rename to docs/user-settings.md index f6ebc7a9e..cbbc10c13 100644 --- a/docs/users-guide/user-settings.md +++ b/docs/user-settings.md @@ -8,7 +8,7 @@ This screen allows you to manage your personal information and account settings ### Profile section -
+
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. -
+
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. -
+
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. diff --git a/docs/users-guide/using-uptime-manager.md b/docs/using-uptime-manager.md similarity index 94% rename from docs/users-guide/using-uptime-manager.md rename to docs/using-uptime-manager.md index 5377cc50f..03fa6ff97 100644 --- a/docs/users-guide/using-uptime-manager.md +++ b/docs/using-uptime-manager.md @@ -41,7 +41,7 @@ The dashboard offers a summary of your uptime monitors: This section lists all the services being monitored, showing key details for each service: -
+
* **Host**: The name and URL of the service being monitored. * **Status**: The current status of the service, indicated by color-coded icons: @@ -68,7 +68,7 @@ The gear icon next to each monitored service allows for quick access to configur ### Table actions -
+
When you click on the gear icon, you'll see a few options that correspond to that host: