CPSECapstone · DamianDhesi · Apr 15, 2024 · Apr 15, 2024 · Apr 15, 2024 · Apr 15, 2024
diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
 # MicroPolyPages
-Since the MicroPoly repo is private, we need a separate repo for the Alpha Release
+Since the MicroPoly repo is private, we need a separate repo for the Alpha Release. This is that repo.
 
 The site can be accessed at https://cpsecapstone.github.io/MicroPolyPages/
diff --git a/_config.yml b/_config.yml
@@ -18,6 +18,14 @@ description: >- # this means to ignore newlines until "baseurl:"
   A machine learning based update scheduler for the windows operating system that adapts
   to the varying schedules of users to ensure updates are as unintrusive as possible.
 
+# this should add a nav bar? Didnt work.
+# header_pages:
+#   - index.html
+#   - contact_issue.md
+#   - demo.md
+#   - installation.md
+#   - licensing.md
+#   - about.md
 # Build settings
 markdown: kramdown
 remote_theme: pages-themes/[email protected]

diff --git a/_includes/nav.html b/_includes/nav.html
@@ -0,0 +1,7 @@
+<p style="text-align: center; background-color: inherit;">
+  <a href="{{site.baseurl}}/" style="color: white; font-weight: bold;">Home</a> |
+  <a href="{{site.baseurl}}/contact_issue_reporting" style="color: white; font-weight: bold;">Contact About Issues</a> | 
+  <a href="{{site.baseurl}}/demo" style="color: white; font-weight: bold;">Demo</a> | 
+  <a href="{{site.baseurl}}/install" style="color: white; font-weight: bold;">Installation</a> | 
+  <a href="{{site.baseurl}}/licensing/" style="color: white; font-weight: bold;">Licensing</a>
+</p>
diff --git a/_includes/navigation.html b/_includes/navigation.html
@@ -0,0 +1,7 @@
+<nav>
+    <a href="/">Home</a>
+    <a href="/demo">Demo</a>
+    <a href="/install">Installation</a>
+    <a href="/licensing">Licensing</a>
+    <a href="/contact_issue_reporting">Contact/Issue Reporting</a>
+</nav>
diff --git a/_layouts/home.html b/_layouts/home.html
@@ -12,13 +12,13 @@
   </head>
 
   <body>
-
     <!-- HEADER -->
     <div id="header_wrap" class="outer">
         <header class="inner">
           {% if site.github.is_project_page %}
             <a id="forkme_banner" href="{{ site.github.repository_url }}">View on GitHub</a>
           {% endif %}
+          {% include nav.html %}
 
           <h1 id="project_title">{{ site.title | default: site.github.repository_name }}</h1>
           <h2 id="project_tagline">{{ site.description | default: site.github.project_tagline }}</h2>
@@ -49,4 +49,4 @@ <h2 id="project_tagline">{{ site.description | default: site.github.project_tagl
       </footer>
     </div>
   </body>
-</html>
+</html>
diff --git a/_layouts/other.html b/_layouts/other.html
@@ -0,0 +1,53 @@
+<!DOCTYPE html>
+<html lang="{{ site.lang | default: "en-US" }}">
+
+  <head>
+    <meta charset='utf-8'>
+    <meta http-equiv="X-UA-Compatible" content="IE=edge">
+    <meta name="viewport" content="width=device-width,maximum-scale=2">
+    <link rel="stylesheet" type="text/css" media="screen" href="{{ '/assets/css/style.css?v=' | append: site.github.build_revision | relative_url }}">
+
+{% seo %}
+    {% include head-custom.html %}
+  </head>
+
+  <body>
+
+    <!-- HEADER -->
+    <div id="header_wrap" class="outer">
+        <header class="inner">
+          {% if site.github.is_project_page %}
+            <a id="forkme_banner" href="{{ site.github.repository_url }}">View on GitHub</a>
+          {% endif %}
+
+          {% include nav.html %}
+
+          <h1 id="project_title">{{ page.title | default: site.github.repository_name }}</h1>
+
+          {% if site.show_downloads %}
+            <section id="downloads">
+              <a class="zip_download_link" href="{{ site.github.zip_url }}">Download this project as a .zip file</a>
+              <a class="tar_download_link" href="{{ site.github.tar_url }}">Download this project as a tar.gz file</a>
+            </section>
+          {% endif %}
+        </header>
+    </div>
+
+    <!-- MAIN CONTENT -->
+    <div id="main_content_wrap" class="outer">
+      <section id="main_content" class="inner">
+        {{ content }}
+      </section>
+    </div>
+
+    <!-- FOOTER  -->
+    <div id="footer_wrap" class="outer">
+      <footer class="inner">
+        {% if site.github.is_project_page %}
+        <p class="copyright">{{ site.title | default: site.github.repository_name }} maintained by <a href="{{ site.github.owner_url }}">{{ site.github.owner_name }}</a></p>
+        {% endif %}
+        <p>Published with <a href="https://pages.github.com">GitHub Pages</a></p>
+      </footer>
+    </div>
+  </body>
+</html>
diff --git a/about.md b/about.md
diff --git a/contact_issue.md b/contact_issue.md
@@ -0,0 +1,7 @@
+---
+layout: other
+title: Contact/Issue Reporting
+permalink: /contact_issue_reporting/
+---
+
+<p>Please report any issues found to the following <a href="https://forms.gle/62xmx4EJvupaECBA8">survey</a></p>
diff --git a/demo.md b/demo.md
@@ -0,0 +1,7 @@
+---
+layout: other
+title: Demo
+permalink: /demo/
+---
+
+<p>View the demo <a href="https://github.com/CPSECapstone/MicroPoly/issues/35">here</a>. Requires repository access</p>
diff --git a/index.md b/index.md
@@ -2,4 +2,45 @@
 
 layout: home
 ---
-<h1>{{ "Hello World!" | downcase }}</h1>
+<h2>The Problem:</h2>
+* Many Windows background updates can disrupt user activities
+* Taking computer resources at inopportune times can be frustrating
+* For example:
+   * Some Operating System updates might affect a user’s game experience, as the update takes some CPU away from the game.
+   * A sound driver update in the middle of a user’s Zoom call could drastically affect their meeting.
+
+<h2>The Current Solution:</h2>
+* Windows Active Hours
+   * Can tell your computer when you are actively using it (Static period for everyday)
+   * Informs update orchestrator and schedules update, install, reboot.
+* Limitations:
+   * A user may have an inconsistent schedule
+   * Students/Teachers use devices more during school year
+   * Use device more/less on weekends
+   * Health conditions interfere (Sleeping problems)
+   * There is a need for scheduler to determine a “good time” to update for each user
+
+<h2>Proposed Solution:</h2>
+<h3>Features:</h3>
+* Improves update timing by adapting to device use over time using a machine learning model, XGBoost.
+* Supports retraining of the ML model
+* Utilizes a scheduled task to collect user data (Runs every 5 minutes)
+    * System Logs
+    * Device State
+    * CPU utility
+    * etc
+* Provides an API for the Windows Update Orchestrator to hit the endpoints and determine when to schedule an update, and whether or not right now is a good time to update.
+* Tracks the accuracy of the model's performance over time.
+
+<h3>MicroPoly API</h3>
+* A RESTful API hosted on the local machine that can be queried to provide a list of good times to install an update, OR to check if the device has the capacity to install the current update now. 
+* The API references several XGBoost models that uses time series forecasting to predict the device’s resource usage for the next day, and uses heuristics from the thresholds provided in the request to determine “good times”.
+
+<h3>Technical Requirements:</h3>
+* The system shall run on machines with a supported version of Windows (10 and 11 as of date) as an executable
+* The ML model shall not exceed 150 MB in size
+* The ML model shall evaluate in 2 seconds or less
+* The system shall support Win32 calls or other standard query calls
+
+<h2>Docs</h2>
+* You can find our final presentations from every quarter, final project architectures, and the MicroPoly Technical Specification in the README of the [GitHub Repo](https://github.com/CPSECapstone/MicroPoly). There is also information on recompiling the production executable.
diff --git a/installation.md b/installation.md
@@ -0,0 +1,46 @@
+---
+layout: other
+title: Install
+permalink: /install/
+---
+
+<h2>{{"1. Download Repository"}}</h2>
+<p>Can be found <a href="https://github.com/CPSECapstone/MicroPoly">here</a></p>
+
+<h2>{{"2. Enter the Root Folder of the Project Directory"}}</h2>
+* Using Powershell or an IDE of your choice.
+
+<h2>{{"3. Start Data Collection, API server, and ML validation"}}</h2>
+<h3>Alpha Release (Development Mode)</h3>
+* Run: python mp-build.py
+    * May need to update/install dotnet and python (refer to part 3.5 then return to part 3)
+    * Creates and starts the data collection task
+    * Sets up a local HTTP server to request "good times" to update
+    * Creates and starts the validation task and associated sub tasks
+    * Gives very meaningful error messages/logs in case the application does not run as expected.
+
+<h3>Beta Release (Production Mode)</h3>
+* Run: start ./production-install.exe
+    * Creates and starts the data collection task
+    * Sets up a local HTTP server to request "good times" to update
+        * Sets up a task to restart the server on login (Server does not persist after a shutdown)
+    * Creates and starts the validation task and associated sub tasks
+    * Will ask for administrator priviledges. 
+
+<h2>{{"3.5. Install Required Dependencies (If Needed)"}}</h2>
+* Run: python --version (Should be Python 3.12+; Else upgrade)
+* Run: winget install Microsoft.DotNet.SDK.8
+* Run: curl https://bootstrap.pypa.io/get-pip.py -o get-pip.py \| python get-pip.py
+
+<h2>4. Utilize HTTP Requests to Recieve "Good Times"</h2>
+* Refer to <a href="/MicroPolyPages/demo/">the demo</a> for example requests and how to interpret responses
+
+<h2>{{"[OPTIONAL] Uninstall MicroPoly"}}</h2>
+* Run: python mp-uninstall.py
+    * Will remove all created tasks, whether you chose to run the dev or production release.
+    * Can choose to remove all required python libraries installed at build time
+    * Can choose to remove all data created at runtime (In out folder)
+* On completion, can delete the root folder to fully uninstall
+
+<br>
+<p>If any issues are found, report them <a href="/MicroPolyPages/contact_issue_reporting/">here</a></p>
diff --git a/licensing.md b/licensing.md
@@ -0,0 +1,13 @@
+---
+layout: other
+title: Licensing
+permalink: /licensing/
+---
+
+<h1>EULA</h1>
+<p>Refer to the licensing agreement for the relevant operating system</p>
+<a href="https://www.microsoft.com/en-us/UseTerms/Retail/Windows/10/UseTerms_Retail_Windows_10_English.htm">Windows 10</a>
+<a href="https://www.microsoft.com/en-us/UseTerms/Retail/Windows/11/UseTerms_Retail_Windows_11_English.htm">Windows 11</a>
+
+<h1>Privacy Policy</h1>
+<p>Refer to <a href="https://privacy.microsoft.com/en-us/privacystatement">Microsoft's Privacy Policy</a> for more information</p>