Add hidden quick start guide for cold front and other hidden docs

docs/coldfront/add_change_project.md

@@ -0,0 +1,94 @@
+# Add or Change Project
+
+```{note}
+Only benefits eligible faculty or staff can create a project.
+```
+
+## Add a Project
+
+1. Click on
+
+    ```{image} ../images/CF/add_change_project/add_project.png
+    :alt: add project
+    :width: 400px
+    ```
+
+2. Give your project a meaningful title.
+
+    ```{image} ../images/CF/add_change_project/title.png
+    :alt: title
+    :width: 800px
+    ```
+
+3. Give your project a meaningful short descriptor. If this is left blank a number will be generated for you.
+
+    ```{image} ../images/CF/add_change_project/short_desc.png
+    :alt: short descriptor
+    :width: 800px
+    ```
+
+    ```{warning}
+    The short descriptor cannot be changed later.
+    ```
+
+4. Give your project a meaningful description.
+
+    ```{image} ../images/CF/add_change_project/description.png
+    :alt: long description
+    :width: 800px
+    ```
+
+5. Select all Departments associated with this project.
+
+    ```{image} ../images/CF/add_change_project/departments.png
+    :alt: departments
+    :width: 800px
+    ```
+
+6. Select all relevant Fields of Science.
+
+    ```{image} 
+    :alt: fields of science
+    :width: 800px
+    ```
+
+7. Select whether or not you have a Data Management Plan. This will not affect your ability to make a project.
+
+    ```{image} ../images/CF/add_change_project/dmp.png
+    :alt: data management plan
+    :width: 800px
+    ```
+
+8. Select your expected end date for the project. This can be extended.
+
+    ```{image} ../images/CF/add_change_project/end_date.png
+    :alt: end date
+    :width: 800px
+    ```
+
+9. Please read and acknowledge that you will follow the ODSRCI Community Guidelines.
+
+10. Click Save to create the project.
+
+    ```{image} ../images/CF/add_change_project/save.png
+    :alt: save
+    :height: 40px
+    ```
+
+## Change a Project
+
+1. From the project page, click on
+
+    ```{image} ../images/CF/add_change_project/update_project.png
+    :alt: update project information
+    :height: 40px
+    ```
+
+2. Change any relevant information for Title, Description, Field of Science, and Departments.
+
+3. Click on
+
+    ```{image} ../images/CF/add_change_project/save.png
+    :alt: save
+    :height: 40px
+    ```

docs/coldfront/add_remove_users.md

@@ -0,0 +1,116 @@
+# Add or Remove Users
+
+```{note}
+Students enrolled in a course will be added automatically as a ***User*** in a class close to the course start date and cannot be removed.
+```
+
+## Roles
+
+Instructors and PI's are automatically assigned the ***Manager*** role within a project. Other users are either a ***Manager*** or a ***User***, with the following permissions:
+
+| Role | Permissions |
+| -------- | ------- |
+| ***Manager*** | add users, remove users, request allocations, use allocations |
+| ***User*** | use allocations |
+
+## Add a User
+
+### To a Project/Class
+
+1. Once a project or class is created, under Manage Project, click on
+
+    ```{image} ../images/CF/add_remove_users/add_users.png
+    :alt: add users
+    :height: 35px
+    ```
+
+3. Type in usernames of the user(s) you would like to add separated by a space or on separate lines.
+
+    ```{image} ../images/CF/add_remove_users/search_user_space.png
+    :alt: search users by space
+    :height: 150px
+    ```
+
+    ```{image} ../images/CF/add_remove_users/search_user_line.png
+    :alt: search users by line
+    :height: 150px
+    ```
+
+4. Click on
+
+    ```{image} ../images/CF/add_remove_users/search_button.png
+    :alt: search button
+    :weight: 700px
+    ```
+
+    ```{note}
+    If a user has already been added to the project or class, then you will see a message like this
+    ```{image} ../images/CF/add_remove_users/user_already_added.png
+    :alt: user already added message
+    :height: 35px
+    :align: center
+    ```
+    ```
+
+5. Select the user(s) that you want to add from the list 
+
+    ```{image} ../images/CF/add_remove_users/select_user.png
+    :alt: select users
+    :height: 60px
+    ```
+
+    and change their role to either ***Manager*** or ***User*** using the dropdown.
+
+    ```{image} ../images/CF/add_remove_users/user_role.png
+    :alt: user role selection
+    :height: 60px
+    ```
+
+6. Click on
+
+    ```{image} ../images/CF/add_remove_users/add_selected_users.png
+    :alt: add selected users
+    :height: 35px
+    ```
+
+7. You can verify that a user has been added under Users on the Project/Class page.
+
+### To an Allocation
+
+```{note}
+When [requesting an allocation](https://southernmethodistuniversity.github.io/hpc_docs/coldfront/request_change_allocation.html) you can give permissions to existing users. The following instructions are for adding users to an active allocation.
+```
+
+## Remove a User
+
+### From a Project/Class
+
+1. Click on <img src="../images/CF/add_remove_users/remove_users.png" alt="remove users button" height="35"/> in the header next to <img src="../images/CF/add_remove_users/users.png" alt="users header" height="35"/>.
+
+2. Select the user(s) that you want to remove from the list.
+
+    <img src="../images/CF/add_remove_users/select_user.png" alt="select users" height="60"/>
+
+3. Click on
+
+    <img src="../images/CF/add_remove_users/remove_selected_users.png" alt="remove selected users" height="40"/>.
+
+4. You can verify that a user has been removed under <img src="../images/CF/add_remove_users/users.png" alt="users header" height="35"/> on the Project/Class page.
+
+### From an Allocation
+
+## Change User
+
+### Role
+
+1. Next to the user's role you would like to change, click on <img src="../images/CF/add_remove_users/actions.png" alt="actions button" height="40"/> under Actions.
+
+2. Change their role using the dropdown:
+
+    <img src="../images/CF/add_remove_users/user_role_change.png" alt="change user role" height="40"/>
+
+3. Click on
+
+    <img src="../images/CF/add_remove_users/update.png" alt="update user" height="40"/>
+
+### Allocation Permissions

docs/coldfront/quick_start.md

@@ -0,0 +1,110 @@
+# Quick Start
+
+## Creating a Project
+
+1. Login to ColdFront via SSO with your SMU ID and Password 
+2. Select Add a project 
+3. Complete the fields  
+4. Select Save once complete.
+
+Once Project is created you will have multiple options to Add additional users, request allocations, add Grant information, and publications.
+
+## To add users
+
+1. Once your project is created, select Add Users within the Users section of your project
+
+    ```{image} ../images/CF/quick_start/add_users.png
+    :alt: add users
+    :width: 400px
+    ```
+
+2. If you are searching by “Exact Username Only” search for the user via SMU email alias
+
+    ```{note}
+    If you are adding multiple users, you can list them all in the Search String box
+    ```
+
+3. If you are searching by “All Fields” you can enter last name or SMU email alias
+
+4. Once you’ve found and selected the user(s), select the role the user should have
+
+    ```{image} ../images/CF/quick_start/user_role.png
+    :alt: user role
+    :width: 100px
+    ```
+
+5. Then Add Selected Users to Project
+6. Once complete you will see all users requested under the Users section
+
+## To Request Resource Allocations
+
+1.	Next to Allocations, Select the **+Request Resource Allocation button**
+2.	Complete all required fields
+3.	Select the users you’d like to add to this allocation
+4.	Select Submit
+5.	Once complete you will see your status request as **Pending Review** under Allocations
+
+    ```{image} ../images/CF/quick_start/resource_table.png
+    :alt: resource table
+    :width: 800px
+    ```
+
+## To view your current usage
+
+1.	Under Allocations select the folder icon
+2.	You will see your Allocation details, EULA Agreements, and Usage by Hours
+
+## To add a class for HPC Access [Faculty/TA ONLY]
+
+1.	Select the **Add a Class** button
+
+    ```{image} ../images/CF/quick_start/add_class.png
+    :alt: add a class button
+    :width: 400px
+    ```
+
+2.	Select your Course and additional sections (if necessary)
+
+    ```{note}
+    If you are adding multiple users, you can list them all in the Search String box
+    ```
+
+3. Check the additional boxes below the sections based off need of the class
+
+4. Select **Save**
+
+    All students enrolled in class will show under Users
+
+    ```{note}
+    All students will appear 7 days before the semester begins.
+    ```
+
+    The Allocations selected previous will show under Allocations, however if additional ones are needed you can add by clicking on the **+Request Resource Allocations** button
+
+    ```{image} ../images/CF/quick_start/request_resource_allocation.png
+    :alt: request resource allocation
+    :width: 200px
+    ```
+
+## Archive a Project
+
+1.	After logging into ColdFront, select your project from the Home Screen
+2.	Select **Archive Project** top right of the page
+3.	To Archive select “Yes” after reading the disclaimer
+
+    ```{image} ../images/CF/quick_start/archive_disclaimer.png
+    :alt: archive disclaimer
+    :width: 800px
+    ```
+
+4. Once you project is successfully archived, you will not be able to make any changes but will still be able to view some details at any time
+
+## To view Archive Projects
+
+1.	After logging into ColdFront, select Projects> Projects
+2.	Top right of your page, you will see View Archived Projects
+
+    ```{image} ../images/CF/quick_start/view_archived.png
+    :alt: view archived
+    :width: 200px
+    ```

docs/coldfront/request_change_allocation.md

@@ -0,0 +1,68 @@
+# Request or Change Resource Allocations
+
+***Managers*** on a project or class can request a ***Compute*** or ***Storage*** Allocation and select which ***User(s)*** should have access to those allocations. All allocation requests will need to be approved by HPC Support.
+
+```{note}
+Please see [Add or Remove Users](https://southernmethodistuniversity.github.io/hpc_docs/coldfront/add_remove_users.html) for how to manage ***User*** permissions on an already active allocation.
+```
+
+## Resource Types
+
+| Resource        | Description                                                                |
+| --------------- | -------------------------------------------------------------------------- |
+| ***Compute***   | Allocates compute time quotas for CPU hours, GPU hours, and memory hours.  |
+| ***Storage***   | Allocates shared folder with storage quotas on memory and number of files. |
+
+## ***Compute*** Allocations
+
+There are 3 fields to specify when requesting a ***Compute*** allocation: ***CPU hours***, ***GPU hours***, and ***memory hours***. Below are descriptions of each field:
+
+| Field              | Description               |
+| ------------------ | ------------------------- |
+| ***CPU hours***    | Computed per job as (number of allocated CPU cores) * (run time in hours). For example, if a job was allocated 64 cores and ran for 30 minutes, it used (64) * (0.5) = 32 ***CPU hours*** of compute time.    |
+| ***GPU hours***    | Computed per job as (number of allocated GPUs) * (run time in hours). For example, if a job was allocated 4 GPUs and ran for 1 hour and 30 minutes, it used (4) * (1.5) = 6 ***GPU hours*** of compute time. |
+| ***Memory hours*** | Computed per job as (amount allocated memory in GB) * (run time in hours). For example, if a job was allocated 128GB of memory and ran for 45 minutes, it used (128) * (0.75) = 96 ***Memory hours***.     |
+
+```{note}
+***CPU hour***, ***GPU hour***, and ***memory hour*** quota's will persist across all M3 queues and SuperPod queues. For example, if you use up your quota of ***GPU hours*** entirely on the gpu-dev queue on M3, then you will not have ***GPU hours*** left to use on M3 or the SuperPod. If you need assistance in determining how many hours to request, please contact [[email protected]](mailto:[email protected]).
+```
+
+### Request ***Compute*** Allocation
+
+1. Select ***+ Request Resource Allocation***.
+
+2. Select ***Compute*** as your Resource from the dropwdown.
+
+3. Provide a 2-3 sentence justification for the resources you are requesting.
+
+4. Select a Start Date and End Date for your allocation. The limit is 1 year, but can be renewed.
+
+5. Enter the number of ***CPU hours*** you will need.
+
+    ```{note}
+    When requesting ***CPU hours***, you <u>MUST</u> request ***memory hours*** as well. The general guideline is that you need 4 ***memory hours*** for 1 ***CPU hour***. If you need assistance in determining how many hours to request, please contact [[email protected]](mailto:[email protected]).
+    ```
+
+6. Enter the number of ***GPU hours*** you will need.
+
+    ```{note}
+    When requesting ***GPU hours***, you <u>MUST</u> request both ***CPU hours*** and ***memory hours*** as well. The general guideline is that you need 16 ***CPU hours*** and 96 ***memory hours*** per 1 ***GPU hour***. If you need assistance in determining how many hours to request, please contact [[email protected]](mailto:[email protected]).
+    ```
+
+6. Enter the number of ***memory hours*** you will need.
+
+7. Please read and acknowledge that you will follow the ODSRCI Community Guidelines.
+
+8. Click on Submit.
+
+9. Wait for your allocation to be approved by HPC Support.
+
+### Change ***Compute*** Allocation
+
+Coming Soon.
+
+## ***Storage*** Allocations
+
+### Request ***Storage*** Allocation
+
+### Change ***Storage*** Allocation