Merge branch 'main' of github.com:nerc-project/nerc-docs into openshift_virtualization_contents

Author: Milstein

.github/workflows/ci.yml

@@ -26,10 +26,10 @@ jobs:
 
         steps:
             - name: Checkout Main
-              uses: actions/checkout@v4
+              uses: actions/checkout@v5
 
             - name: Set up Python ${{ matrix.python-version }}
-              uses: actions/setup-python@v5
+              uses: actions/setup-python@v6
               with:
                   python-version: ${{ matrix.python-version }}
             - name: Install dependencies and setup git config
@@ -58,10 +58,10 @@ jobs:
         if: github.ref == 'refs/heads/main'
         steps:
             - name: Checkout Main
-              uses: actions/checkout@v4
+              uses: actions/checkout@v5
 
             - name: Set up Python ${{ matrix.python-version }}
-              uses: actions/setup-python@v5
+              uses: actions/setup-python@v6
               with:
                   python-version: ${{ matrix.python-version }}
             - name: Install dependencies and setup git config

.github/workflows/precommit.yaml

@@ -9,10 +9,10 @@ jobs:
         runs-on: ubuntu-latest
         steps:
             - name: Check out code
-              uses: actions/checkout@v4
+              uses: actions/checkout@v5
 
             - name: Setup Python
-              uses: actions/setup-python@v5
+              uses: actions/setup-python@v6
               with:
                   python-version: ^3.10
 

.markdownlint.yaml

@@ -11,3 +11,4 @@ MD033: false
 MD041: false
 MD046: false
 MD049: false
+MD059: false

.pre-commit-config.yaml

@@ -12,7 +12,7 @@ repos:
           - id: remove-tabs
 
     - repo: https://github.com/pre-commit/pre-commit-hooks
-      rev: v5.0.0
+      rev: v6.0.0
       hooks:
           - id: trailing-whitespace
             args: [--markdown-linebreak-ext=md]
@@ -28,7 +28,7 @@ repos:
           - id: detect-private-key
 
     - repo: https://github.com/adrienverge/yamllint
-      rev: v1.36.2
+      rev: v1.37.1
       hooks:
           - id: yamllint
             files: \.(yaml|yml)$
@@ -37,7 +37,7 @@ repos:
             exclude: .*.param.yaml
 
     - repo: https://github.com/igorshubovych/markdownlint-cli
-      rev: v0.44.0
+      rev: v0.45.0
       hooks:
           - id: markdownlint
             args: [-c, .markdownlint.yaml, --fix]
@@ -50,7 +50,7 @@ repos:
             exclude: .*/tests/.*
 
     - repo: https://github.com/pycqa/flake8
-      rev: 7.1.2
+      rev: 7.3.0
       hooks:
           - id: flake8
             args:

docs/get-started/allocation/adding-a-new-allocation.md

@@ -55,4 +55,25 @@ shown below:
     [this documentation](allocation-change-request.md#request-change-resource-allocation-attributes-for-openshift-project)
     later on.
 
+## Adding a new Resource Allocation to your Academic (EDU) OpenShift project
+
+![Adding a new Resource Allocation to your Academic (EDU) OpenShift project](images/coldfront-request-a-new-openshift-edu-allocation.png)
+
+!!! warning "Note: Requested/Approved Academic (EDU) OpenShift Storage Quota & Cost"
+
+    Ensure you choose **NERC-OCP-EDU (OpenShift)** in the Resource option (**Always
+    Remember**: the first option, i.e. **NERC (OpenStack)** is selected by default!).
+    Each allocation, whether requested or approved, will be billed based on the
+    **pay-as-you-go** model. The exception is for **Storage quotas**, where the
+    cost is determined by [your requested and approved allocation values](allocation-details.md#pi-and-manager-allocation-view-of-openshift-resource-allocation)
+    to reserve storage from the total NESE storage pool. For **NERC-OCP-EDU (OpenShift)**
+    Resource Allocations, storage quotas are specified by the "OpenShift Request
+    on Storage Quota (GiB)" and "OpenShift Limit on Ephemeral Storage Quota (GiB)"
+    allocation attributes. If you have common questions or need more information,
+    refer to our [Billing FAQs](../../get-started/cost-billing/billing-faqs.md)
+    for comprehensive answers. Keep in mind that you can easily scale and expand
+    your current resource allocations within your project by following
+    [this documentation](allocation-change-request.md#request-change-resource-allocation-attributes-for-openshift-project)
+    later on.
+
 ---

docs/get-started/allocation/allocation-change-request.md

@@ -116,10 +116,10 @@ as any other compute instance, with a few considerations to keep in mind:
 
 !!! warning "Important: Requested/Approved Allocated OpenShift Storage Quota & Cost"
 
-    For **NERC-OCP (OpenShift)** resource types, the **Storage quotas** are controlled
-    by the values of the "OpenShift Request on Storage Quota (GiB)" and "OpenShift
-    Limit on Ephemeral Storage Quota (GiB)" quota attributes. The **Storage cost**
-    is determined by [your requested and approved allocation values](allocation-details.md#pi-and-manager-allocation-view-of-openshift-resource-allocation)
+    For **NERC-OCP (OpenShift)** and **NERC-OCP-EDU (OpenShift)** resource types,
+    the **Storage quotas** are controlled by the values of the "OpenShift Request
+    Storage Quota (GiB)" and "OpenShift Limit on Ephemeral Storage Quota (GiB)"
+    quota attributes. The **Storage cost** is determined by [your requested and approved allocation values](allocation-details.md#pi-and-manager-allocation-view-of-openshift-resource-allocation)
     for these quota attributes.
 
 PI or project managers can provide a new value for the individual quota attributes,

docs/get-started/allocation/allocation-details.md

@@ -49,6 +49,10 @@ PIs and managers can add or remove users from allocations.
 
 ![PI and Manager Allocation View of OpenShift Resource Allocation](images/coldfront-openshift-allocation-pi-manager-view.png)
 
+### PI and Manager Allocation View of Academic (EDU) OpenShift Resource Allocation
+
+![PI and Manager Allocation View of Academic (EDU) OpenShift Resource Allocation](images/coldfront-openshift-edu-allocation-pi-manager-view.png)
+
 ## General User View
 
 General Users who are not PIs or Managers on a project see a read-only view of the
@@ -64,4 +68,8 @@ to access the Allocation detail page.
 
 ![General User View of OpenShift Resource Allocation](images/coldfront-openshift-allocation-general-user-view.png)
 
+### General User View of Academic (EDU) OpenShift Resource Allocation
+
+![General User View of Academic (EDU) OpenShift Resource Allocation](images/coldfront-openshift-edu-allocation-general-user-view.png)
+
 ---

docs/get-started/allocation/archiving-a-project.md

@@ -13,7 +13,7 @@ by accessing [NERC's ColdFront interface](https://coldfront.mss.mghpcc.org/).
 
 Once archived it is no longer visible on [your projects list](https://coldfront.mss.mghpcc.org/project/).
 All archived projects will be listed under [your archived projects](https://coldfront.mss.mghpcc.org/project/archived/),
-which can be viewed by clicking the "View archived projects" button as shown below:
+which can be viewed by clicking the "View archived projects" button, as shown below:
 
 ![View Archived Projects](images/view_archived_projects.png)