updated docs to fix the lint

nerc-project · Aug 1, 2024 · 209c6ea · 209c6ea
1 parent f5ba6f9
commit 209c6ea
Show file tree

Hide file tree

Showing 21 changed files with 161 additions and 130 deletions.
diff --git a/docs/about.md b/docs/about.md
@@ -40,3 +40,5 @@ use the services.
 For more information,
 [view](https://docs.google.com/document/d/1-bwdvVCx_pufAidylJGUH0E3jAjfg2TQibDPTO4yDt0/edit?usp=sharing)
 NERC's concept document.
+
+---
diff --git a/docs/get-started/allocation/coldfront.md b/docs/get-started/allocation/coldfront.md
@@ -25,8 +25,9 @@ is granted, the PI will receive an email confirming the request approval and
 how to connect NERC's ColdFront.
 
 PI or project managers can use NERC's ColdFront as a self-service web-portal that
-can see an administrative view of it as [described here](coldfront.md#pi-and-manager-view)
-and can do the following tasks:
+can see an administrative view of it as
+[described here](../allocation/allocation-details.md#pi-and-manager-view) and can
+do the following tasks:
 
 - **Only PI** can add a new project and archive any existing project(s)
 

diff --git a/docs/migration-moc-to-nerc/Step1.md b/docs/migration-moc-to-nerc/Step1.md
@@ -1,8 +1,7 @@
 # Creating NERC Project and Networks
 
 This process includes some waiting for emails and approvals. It is advised to
-start this process and then move to [step
-2](../Step2/)
+start this process and then move to [Step 2](./Step2.md)
 and continue with these steps once you recieve approval.
 
 ## Account Creation & Quota Request

diff --git a/docs/migration-moc-to-nerc/Step2.md b/docs/migration-moc-to-nerc/Step2.md
@@ -87,27 +87,27 @@ samples below your lists might look like this:
 
 #### MOC Instance Information Table
 
-| Instance Name | MOC VCPUs | MOC Disk | MOC RAM | MOC UUID |
-| ------------- | --------- | -------- | ------- | -------- |
-| Fedora_test | 1 | 10GB | 1GB | 16a1bfc2-8c90-4361-8c13-64ab40bb6207 |
-| Ubuntu_Test | 1 | 10GB | 2GB | 6a40079a-59f7-407c-9e66-23bc5b749a95 |
-| total | 2 | 20GB | 3GB | |
+| Instance Name | MOC VCPUs | MOC Disk | MOC RAM | MOC UUID                             |
+| ------------- | --------- | -------- | ------- | ------------------------------------ |
+| Fedora_test   | 1         | 10GB     | 1GB     | 16a1bfc2-8c90-4361-8c13-64ab40bb6207 |
+| Ubuntu_Test   | 1         | 10GB     | 2GB     | 6a40079a-59f7-407c-9e66-23bc5b749a95 |
+| total         | 2         | 20GB     | 3GB     |                                      |
 
 #### MOC Volume Information Table
 
-| MOC Volume Name | MOC Disk | MOC Attached To | Bootable | MOC UUID | NERC Volume Name |
-| --------------- | -------- | --------------- | -------- | -------- | ---------------- |
-| Fedora | 10GiB | Fedora_test | Yes | ea45c20b-434a-4c41-8bc6-f48256fc76a8 |   |
-| 9c73295d-fdfa-4544-b8b8-a876cc0a1e86 | 10GiB | Ubuntu_Test | Yes | 9c73295d-fdfa-4544-b8b8-a876cc0a1e86 |   |
-| Snapshot of Fed_Test | 10GiB | Fedora_test | No | ea45c20b-434a-4c41-8bc6-f48256fc76a8 |   |
-| total | 30GiB |   |   |   |   |
+| MOC Volume Name                      | MOC Disk | MOC Attached To | Bootable | MOC UUID                             | NERC Volume Name |
+| ------------------------------------ | -------- | --------------- | -------- | ------------------------------------ | ---------------- |
+| Fedora                               | 10GiB    | Fedora_test     | Yes      | ea45c20b-434a-4c41-8bc6-f48256fc76a8 |                  |
+| 9c73295d-fdfa-4544-b8b8-a876cc0a1e86 | 10GiB    | Ubuntu_Test     | Yes      | 9c73295d-fdfa-4544-b8b8-a876cc0a1e86 |                  |
+| Snapshot of Fed_Test                 | 10GiB    | Fedora_test     | No       | ea45c20b-434a-4c41-8bc6-f48256fc76a8 |                  |
+| total                                | 30GiB    |                 |          |                                      |                  |
 
 #### MOC Security Group Information Table
 
 | Security Group Name | Direction | Ether Type | IP Protocol | Port Range | Remote IP Prefix |
 | ------------------- | --------- | ---------- | ----------- | ---------- | ---------------- |
-| ssh_only_test | Ingress | IPv4 | TCP | 22 | 0.0.0.0/0 |
-| ping_only_test | Ingress | IPv4 | ICMP | Any | 0.0.0.0/0 |
+| ssh_only_test       | Ingress   | IPv4       | TCP         | 22         | 0.0.0.0/0        |
+| ping_only_test      | Ingress   | IPv4       | ICMP        | Any        | 0.0.0.0/0        |
 
 ### Gather the Instance Information
 

diff --git a/docs/migration-moc-to-nerc/Step3.md b/docs/migration-moc-to-nerc/Step3.md
@@ -4,19 +4,19 @@
 
 1. The values you will want to keep track of are.
 
-    | Label | Value |
-    | ----- | ----- |
-    | MOCAccess | |
-    | MOCSecret | |
-    | NERCAccess | |
-    | NERCSecret | |
-    | MOCEndPoint | `https://kzn-swift.massopen.cloud` |
-    | NERCEndPoint | `https://stack.nerc.mghpcc.org:13808` |
-    | MinIOVolume | |
-    | MOCVolumeBackupID | |
-    | ContainerName | |
-    | NERCVolumeBackupID | |
-    | NERCVolumeName | |
+   | Label              | Value                                 |
+   | ------------------ | ------------------------------------- |
+   | MOCAccess          |                                       |
+   | MOCSecret          |                                       |
+   | NERCAccess         |                                       |
+   | NERCSecret         |                                       |
+   | MOCEndPoint        | `https://kzn-swift.massopen.cloud`    |
+   | NERCEndPoint       | `https://stack.nerc.mghpcc.org:13808` |
+   | MinIOVolume        |                                       |
+   | MOCVolumeBackupID  |                                       |
+   | ContainerName      |                                       |
+   | NERCVolumeBackupID |                                       |
+   | NERCVolumeName     |                                       |
 
 2. It is also helpful to have a text editor open so that you can insert
 the values from the spreadsheet into the commands that need to be run.
@@ -216,7 +216,7 @@ interface of the object-store service `<NERCEndPoint>` and the EC2 access key (e
 ### Backup MOC Volumes
 
 1. Locate the desired Volume UUID from the table you created in
-[Step 2 Gathering MOC Information](../Step2/#moc-volume-information-table).
+[Step 2 Gathering MOC Information](./Step2.md#moc-volume-information-table).
 
 1. Add the first Volume ID from your table to the code below in the
 `<MOCVolumeID>` field and create a Container Name to replace the
@@ -298,10 +298,9 @@ the same size or larger than the original volume which can be changed by
 modifying the `<size>` field. Remove the "--bootable" flag if you are not
 creating a bootable volume. The `<NERCVolumeName>` field can be any name you want,
 I would suggest something that will help you keep track of what instance you
-want to attach it to. Make sure to fill in the table you created in [Step 2][]
-with the `<NERCVolumeName>` value in the `NERC Volume Name` column.
-
-[Step 2]: ../Step2/#moc-volume-information-table
+want to attach it to. Make sure to fill in the table you created in
+[Step 2](./Step2.md#moc-volume-information-table)with the `<NERCVolumeName>` value
+in the `NERC Volume Name` column.
 
         openstack --os-cloud nerc volume create --bootable --size <size> <NERCVolumeName>
         +---------------------+----------------+

diff --git a/docs/migration-moc-to-nerc/Step4.md b/docs/migration-moc-to-nerc/Step4.md
@@ -78,10 +78,8 @@ Overview.
 
 1. Only remove Volume Backups you are sure have been migrated to NERC Volumes.
 Keep in mind that you might not have named the volume the same as on the MOC so
-check your table from [Step 2][] to confirm.You can confirm what Volumes you
-have in NERC with the following command.
-
-[Step 2]: ../Step2/#moc-volume-information-table
+check your table from [Step 2](./Step2.md#moc-volume-information-table) to confirm.
+You can confirm what Volumes you have in NERC with the following command.
 
         openstack --os-cloud nerc volume list
         +----------------+------------------+--------+------+----------------------------------+

diff --git a/docs/openshift-ai/data-science-project/model-serving-in-the-rhoai.md b/docs/openshift-ai/data-science-project/model-serving-in-the-rhoai.md
@@ -5,7 +5,7 @@
 To run a **model server** and **deploy a model** on it, you need to have:
 
 - Select the correct data science project and create workbench, see [Populate
-the data science project](using-projects-the-rhoai.md#populate-the-data-science-project)
+the data science project](using-projects-the-rhoai.md#populate-the-data-science-project-with-a-workbench)
 for more information.
 
 ## Create a data connection

diff --git a/...penshift-ai/other-projects/configure-jupyter-notebook-use-gpus-aiml-modeling.md b/...penshift-ai/other-projects/configure-jupyter-notebook-use-gpus-aiml-modeling.md
@@ -5,7 +5,7 @@
 Prepare your Jupyter notebook server for using a GPU, you need to have:
 
 - Select the correct data science project and create workbench, see
-[Populate the data science project](../data-science-project/using-projects-the-rhoai.md#populate-the-data-science-project)
+[Populate the data science project](../data-science-project/using-projects-the-rhoai.md#populate-the-data-science-project-with-a-workbench)
 for more information.
 
 Please ensure that you start your Jupyter notebook server with options as depicted

diff --git a/.../openshift-ai/other-projects/how-access-s3-data-then-download-and-analyze-it.md b/.../openshift-ai/other-projects/how-access-s3-data-then-download-and-analyze-it.md
@@ -5,7 +5,7 @@
 Prepare your Jupyter notebook server for using a GPU, you need to have:
 
 - Select the correct data science project and create workbench, see
-[Populate the data science project](../data-science-project/using-projects-the-rhoai.md#populate-the-data-science-project)
+[Populate the data science project](../data-science-project/using-projects-the-rhoai.md#populate-the-data-science-project-with-a-workbench)
 for more information.
 
 Please ensure that you start your Jupyter notebook server with options as depicted

diff --git a/docs/openshift/decommission/decommission-openshift-resources.md b/docs/openshift/decommission/decommission-openshift-resources.md
@@ -246,7 +246,7 @@ Wait until the requested resource allocation gets approved by the NERC's admin.
 After approval, kindly review and verify that the quotas are accurately
 reflected in your [resource allocation](https://coldfront.mss.mghpcc.org/allocation/)
 and [OpenShift project](https://console.apps.shift.nerc.mghpcc.org). Please ensure
-that the approved quota values are accurately displayed as [explained here](decommission-openshift-resources.md#review-your-projects-resource-quota-from-openshift-web-dashboard).
+that the approved quota values are accurately displayed as [explained here](#review-your-projects-resource-quota-from-the-openshift-web-console).
 
 ### Review your Project Usage
 

diff --git a/...anced-openstack-topics/setting-up-your-own-images/how-to-build-windows-image.md b/...anced-openstack-topics/setting-up-your-own-images/how-to-build-windows-image.md
@@ -362,7 +362,7 @@ Attach a Floating IP to your instance:
 
 !!! note "More About Floating IP"
     If you don't have any available floating IPs, please refer to
-    [this documentation](../../create-and-connect-to-the-VM/assign-a-floating-IP.md#release-a-floating-ip#allocate-a-floating-ip)
+    [this documentation](../../create-and-connect-to-the-VM/assign-a-floating-IP.md#allocate-a-floating-ip)
     on how to allocate a new Floating IP to your project.
 
 Click on detail view of the Instance and then click on Console tab menu

diff --git a/docs/openstack/create-and-connect-to-the-VM/bastion-host-based-ssh/index.md b/docs/openstack/create-and-connect-to-the-VM/bastion-host-based-ssh/index.md
@@ -31,7 +31,7 @@ via Bastion Host, you need to make sure you have followed these steps:
 to set up a public ssh key. You can use the same key for both the bastion
 host and the remote instances, or different keys; you'll just need to ensure
 that the keys are loaded by ssh-agent appropriately so they can be used as
-needed. Please read [this instruction](../../access-and-security/create-a-key-pair/#adding-your-ssh-key-to-the-ssh-agent)
+needed. Please read [this instruction](../../access-and-security/create-a-key-pair.md#adding-your-ssh-key-to-the-ssh-agent)
 on how to add ssh-agent and load your private key using ssh-add command to
 access the bastion host.
 
@@ -65,8 +65,8 @@ will be used by any private instances.
 **i. Bastion Host Security Group:**
 
 Allow inbound SSH (optional ICMP) for this security group. Make sure you have
-added rules in the [Security Groups](../../access-and-security/security-groups/
-) to allow ssh to the bastion host.
+added rules in the [Security Groups](../../access-and-security/security-groups.md)
+to allow ssh to the bastion host.
 
 ![Bastion Host Security Group](images/bastion_host_security_group.png)
 

diff --git a/docs/openstack/create-and-connect-to-the-VM/create-a-Windows-VM.md b/docs/openstack/create-and-connect-to-the-VM/create-a-Windows-VM.md
@@ -226,7 +226,7 @@ To list all Floating IP addresses that are allocated to the current project, run
 
 !!! note "More About Floating IP"
     If the above command returns an empty list, meaning you don't have any
-    available floating IPs, please refer to [this documentation](assign-a-floating-IP.md#release-a-floating-ip#allocate-a-floating-ip)
+    available floating IPs, please refer to [this documentation](assign-a-floating-IP.md#allocate-a-floating-ip)
     on how to allocate a new Floating IP to your project.
 
 Attach a Floating IP to your instance:
@@ -284,7 +284,7 @@ should work with the Floating IP associated with the instance:
 
 To attach additional disk to a running Windows machine you can follow
 [this documentation](../persistent-storage/volumes.md).
-[**This guide**](../persistent-storage/volumes.md#for-windows-virtual-machine)
+[**This guide**](../persistent-storage/format-and-mount-the-volume.md#for-windows-virtual-machine)
 provides instructions on formatting and mounting a volume as an attached disk
 within a Windows virtual machine.
 

diff --git a/docs/openstack/create-and-connect-to-the-VM/ssh-to-the-VM.md b/docs/openstack/create-and-connect-to-the-VM/ssh-to-the-VM.md
@@ -332,7 +332,7 @@ Press **Yes** if you receive the identity verification popup:
 ![RDP Windows Popup](images/rdp_popup_for_xrdp.png)
 
 Then, enter your VM's username (ubuntu) and the password you created
-for user ubuntu following [this steps](ssh-to-the-VM.md#setting-a-password.md).
+for user ubuntu following [this steps](#setting-a-password).
 
 Press **Ok**.
 

diff --git a/docs/openstack/decommission/decommission-openstack-resources.md b/docs/openstack/decommission/decommission-openstack-resources.md
@@ -150,7 +150,7 @@ Wait until the requested resource allocation gets approved by the NERC's admin.
 After approval, kindly review and verify that the quotas are accurately
 reflected in your [resource allocation](https://coldfront.mss.mghpcc.org/allocation/)
 and [OpenStack project](https://stack.nerc.mghpcc.org/). Please ensure that the
-approved quota values are accurately displayed as [explained here](decommission-openstack-resources.md#review-your-openstack-dashboard).
+approved quota values are accurately displayed as [explained here](#review-your-projects-resource-quota-from-the-openstack-dashboard).
 
 ### Review your Block Storage(Volume/Cinder) Quota
 

diff --git a/docs/openstack/persistent-storage/object-storage.md b/docs/openstack/persistent-storage/object-storage.md
@@ -887,7 +887,7 @@ Then you can simply mount your object storage with:
 `rclone -vv --vfs-cache-mode writes mount nerc: ~/mnt-rclone`
 
 !!! note "More about using Rclone"
-    You can read more about Rclone Mounting [here](mount-the-object-storage.md#3-using-rclone).
+    You can read more about Rclone Mounting [here](mount-the-object-storage.md#4-using-rclone).
 
 **Windows:**
 

diff --git a/docs/other-tools/index.md b/docs/other-tools/index.md
@@ -7,17 +7,20 @@
 ## i. **Kubernetes Development environment**
 
 1. [Minikube](kubernetes/minikube.md)
+
 2. [Kind](kubernetes/kind.md)
+
 3. [MicroK8s](kubernetes/microk8s.md)
+
 4. [K3s](kubernetes/k3s/k3s.md)
 
-    5.a. [K3s with High Availibility(HA) setup](kubernetes/k3s/k3s-ha-cluster.md)
+    4.a. [K3s with High Availibility(HA) setup](kubernetes/k3s/k3s-ha-cluster.md)
 
-    5.b. [Multi-master HA K3s cluster using k3sup](kubernetes/k3s/k3s-using-k3sup.md)
+    4.b. [Multi-master HA K3s cluster using k3sup](kubernetes/k3s/k3s-using-k3sup.md)
 
-    5.c. [Single-Node K3s Cluster using k3d](kubernetes/k3s/k3s-using-k3d.md)
+    4.c. [Single-Node K3s Cluster using k3d](kubernetes/k3s/k3s-using-k3d.md)
 
-    5.d. [Multi-master K3s cluster setup using k3d](kubernetes/k3s/k3s-ha-cluster-using-k3d.md)
+    4.d. [Multi-master K3s cluster setup using k3d](kubernetes/k3s/k3s-ha-cluster-using-k3d.md)
 
 5. [k0s](kubernetes/k0s.md)
 

diff --git a/docs/stylesheets/extra.css b/docs/stylesheets/extra.css
@@ -9,8 +9,8 @@
   padding: 25px 0px 25px 0px;
 }
 
-footer [class ^= 'footer-'] {
-  width: 25%;
+footer [class^="footer-"] {
+  width: 24%;
   display: inline-block;
   text-align: center;
 }
@@ -32,7 +32,7 @@ footer .footer-center {
   position: absolute;
   top: 50%;
   transform: translate(0, -50%);
-  border: 5px solid #FFFF00;
+  border: 5px solid #ffff00;
   padding: 10px;
 }
 
@@ -42,21 +42,21 @@ footer .footer-center {
   height: 55px;
   /* width: 200px; */
   position: relative;
-  }
+}
 
-  .maintain{
-    position: absolute;
-    top: 5%;
-    /* left: 50%; */
-    /* margin: -25px 0 0 -35px; */
-  }
+.maintain {
+  position: absolute;
+  top: 5%;
+  /* left: 50%; */
+  /* margin: -25px 0 0 -35px; */
+}
 
-  .child {
-    /* background: #FFFF00;
+.child {
+  /* background: #ffff00;
     width: 70px;
     height: 70px; */
-    position: absolute;
-    top: 50%;
-    left: 50%;
-    margin: -25px 0 0 -35px;
-  }
+  position: absolute;
+  top: 50%;
+  left: 50%;
+  margin: -25px 0 0 -35px;
+}