Merge pull request #213 from SouthernMethodistUniversity/cf_docs

Cf docs
SouthernMethodistUniversity · Aug 21, 2024 · a5fe6f4 · a5fe6f4
2 parents d24545f + cb44bd9
commit a5fe6f4
Show file tree

Hide file tree

Showing 4 changed files with 18 additions and 17 deletions.
diff --git a/docs/coldfront/add_class.md b/docs/coldfront/add_class.md
@@ -11,13 +11,12 @@ please reach out to [[email protected]](mailto:help%40smu.edu?subject=%5BHPC%5D) and
 
 ### Setting up your class
 
-```{image} ../images/CF/quick_start/add_class.png
-:alt: add a class button
-:width: 400px
-```
-
-1. Login to ColdFront via SSO with your SMU credentials
-2. Select Add a class 
+1. Login to [ColdFront](https://hpcaccess.smu.edu) via SSO with your SMU credentials
+2. Select Add a class
+    ```{image} ../images/CF/quick_start/add_class.png
+    :alt: add a class button
+    :width: 400px
+    ```
 3. Select your course from the drop down menu
 4. Select which sections you would like to have access to HPC resources
 5. Mark which additional options you need

diff --git a/docs/coldfront/qs_instructor.md b/docs/coldfront/qs_instructor.md
@@ -5,15 +5,17 @@ If you are the instructor of record in my.smu, much of this process will be easy
 If you are not an instructor of record for a course but would like to set up a course (e.g. workshop or bootcamp), 
 please reach out to [[email protected]](mailto:help%40smu.edu?subject=%5BHPC%5D) and include [HPC] in the subject line.
 
-## Setting up your class
+More information on [ColdFront](https://hpcaccess.smu.edu) is available [here](https://www.smu.edu/provost/odonnell-institute/hpc/cf).
 
-```{image} ../images/CF/quick_start/add_class.png
-:alt: add a class button
-:width: 400px
-```
+## Setting up your class
 
-1. Login to ColdFront via SSO with your SMU credentials
-2. Select Add a class 
+1. Login to [ColdFront](https://hpcaccess.smu.edu) via SSO with your SMU credentials
+2. Select Add a class
+
+    ```{image} ../images/CF/quick_start/add_class.png
+    :alt: add a class button
+    :width: 400px
+    ```
 3. Select your course from the drop down menu
 4. Select which sections you would like to have access to HPC resources
 5. Mark which additional options you need

diff --git a/docs/coldfront/qs_student.md b/docs/coldfront/qs_student.md
@@ -4,7 +4,7 @@ These instructions will help you get access to HPC resources in your class.
 
 ## Getting to ColdFront
 
-ColdFront is a platform for managing access to our HPC resources. You will need to go to [hpcaccess.smu.edu](hpcaccess.smu.edu) and log in to ColdFront using SSO.
+[ColdFront](https://www.smu.edu/provost/odonnell-institute/hpc/cf) is a platform for managing access to our HPC resources. You will need to go to [hpcaccess.smu.edu](https://hpcaccess.smu.edu) and log in to ColdFront using SSO.
 
 ## In Class
 

diff --git a/docs/coldfront/quick_start.md b/docs/coldfront/quick_start.md
@@ -2,7 +2,7 @@
 
 ## Creating a Project
 
-1. Login to ColdFront via SSO with your SMU ID and Password 
+1. Login to [ColdFront](https://hpcaccess.smu.edu) via SSO with your SMU ID and Password 
 2. Select Add a project 
 3. Complete the fields  
 4. Select Save once complete.
@@ -107,4 +107,4 @@ Once Project is created you will have multiple options to Add additional users,
     ```{image} ../images/CF/quick_start/view_archived.png
     :alt: view archived
     :width: 200px
-    ```
+    ```