Shecdule test

.github/workflows/demo_deploy.yml

@@ -0,0 +1,53 @@
+name: Deploy PR branches
+on: 
+  pull_request:
+env:
+  MODULE_LIST_PATH: docs/assets/module-list.json
+  PYTHON_VERSION: 3.x
+  GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+  TARGET_REPO: "support-docs-dev"
+  TARGET_OWNER: "CallumWalley"
+  WORKFLOW_ID: "deploy.yml"
+  DEPLOY_URL: "https://callumwalley.github.io/support-docs-dev"
+permissions: write-all
+jobs:
+  documentation:
+    name: Build documentation
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          ssh-key: ${{ secrets.SSH_PRIVATE_KEY }}
+          fetch-depth: 0
+      - name: Get list of dev deployments
+        id: dev-deps
+        run: |
+          echo "branches=$(for pr in $(gh pr list --json headRefName | jq -r '.[].headRefName'); do gh pr checks $pr > /dev/null && printf "${pr} "; done)" >> $GITHUB_OUTPUT
+      - name: make private key
+        run: echo "${{ secrets.SSH_PRIVATE_KEY }}" > id_ed25519
+      - name: Trigger Workflow in Another Repository
+        run: |
+          curl -L \
+            --key id_ed25519 \
+            -X POST \
+            -H "Accept: application/vnd.github+json" \
+            -H "Authorization: Bearer ${{ secrets.PAT }}" \
+            -H "X-GitHub-Api-Version: 2022-11-28" \
+            https://api.github.com/repos/${TARGET_OWNER}/${TARGET_REPO}/dispatches \
+            -d '{"event_type":"deploy","client_payload":{"pr-branches":"${{ steps.dev-deps.outputs.branches }}"}}'
+
+            # gh api \
+          #   --method POST \
+          #   -H "Accept: application/vnd.github+json" \
+          #   -H "X-GitHub-Api-Version: 2022-11-28" \
+          #   /repos/${TARGET_OWNER}/${TARGET_REPO}/dispatches \
+          #   -f "event_type=deploy" -F "client_payload[pr-branches]=${{ steps.dev-deps.outputs.branches }}"
+
+          # gh workflow run ${WORKFLOW_ID} --repo ${TARGET_OWNER}/${TARGET_REPO} --field pr-branches="${{ steps.dev-deps.outputs.branches }}"
+      - name: Post messages to PRs
+        run: |
+          for pr in ${{ steps.dev-deps.outputs.branches }}; do
+            msg="Test deployment available at <a href=\"${DEPLOY_URL}/${pr}\">${DEPLOY_URL}/${pr}</a>"
+            (gh pr comment ${pr} --edit-last --body "${msg}") || (gh pr comment ${pr} --body "${msg}")
+          done

.github/workflows/deploy.yml

@@ -3,11 +3,18 @@ on:
  push:
     branches: [main]
  workflow_dispatch:
+  inputs:
+    pr-deploy:
+      description: Deploy open merge requests in sub-directories.
+      type: boolean
+      default: true
 env:
   MODULE_LIST_PATH: docs/assets/module-list.json
   PYTHON_VERSION: 3.x
+  GH_TOKEN: ${{ github.token }}
 permissions:
   contents: write
+  pull-requests:  write
   id-token: write
   pages: write
 jobs:
@@ -39,7 +46,7 @@ jobs:
         run: pip install -r requirements.txt
       - name: Build documentation
         run: |
-          mkdocs build --clean --quiet
+              mkdocs build --clean --quiet
       - name: Adjust permissions
         run: |
           chmod -c -R +rX public/ | while read line; do
@@ -56,3 +63,10 @@ jobs:
         with:
           key: mkdocs-${{ hashfiles('.cache/**') }}
           path: .cache
+      - name: Post messages to PRs
+        run: |
+          for pr in ${{ steps.dev-deps.outputs.branches }}; do
+            msg="Test deployment available at <a href=\"https://docs.nesi.org.nz/${pr}\">https://docs.nesi.org.nz/${pr}</a>"
+            (gh pr comment ${pr} --edit-last --body "${msg}") || (gh pr comment ${pr} --body "${msg}")
+          done
+

.github/workflows/schedule.yml

@@ -1,5 +1,7 @@
 name: Merge Schedule
 on:
+  issue_comment:
+    types: [created, edited]
   pull_request:
     types:
       - opened
@@ -15,7 +17,8 @@ jobs:
         with:
           merge_method: squash
           # Time zone to use. Default is UTC.
-          time_zone: 'New_Zealand/Auckland'
+          # time_zone: 'Pacific/Auckland'
           require_statuses_success: 'true'
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+

.vscode/includes.code-snippets

@@ -67,7 +67,7 @@
 			"#SBATCH --time            ${3:01:00:00}",
 			"#SBATCH --mem             ${4:2G}",
 			"",
-			"${0}"
+			"${0}",
 			"```"
 		]
 	},
@@ -79,8 +79,9 @@
 	"Insert Front Matter": {
 		"scope": "markdown",
 		"prefix": ["---"],
+		"description" : "Insert Meta",
 		"body": [
-			"---"
+			"---",
 			"created_at: $CURRENT_YEAR-$CURRENT_MONTH-$CURRENT_DATE",
 			// "title: ${1:${TM_FILENAME/_/ /g}}}",
 			"description: ${1}",
@@ -89,5 +90,32 @@
 			"",
 			"${0}"
 		]
-	}
+	},
+	// For more elaborate page templates see: https://marketplace.visualstudio.com/items?itemName=rioj7.vscode-file-templates
+	"Template New Page": {
+		"isFileTemplate": true,
+		"body": [
+		"---",
+		"created_at: $CURRENT_YEAR-$CURRENT_MONTH-$CURRENT_DATE",
+		"description: ${1:Will be used to generate page preview. Should not contain keywords not in the body of article.}",
+		"tags: [${2:tag1},${3:tag2}]",
+		"---",
+		"",
+		"${4:Short preface to article.}",
+		"",
+		"##${5:L2 Header}",
+		"",
+		"##${6:L3 Header}",
+		"",
+		"=== \"First Tab\"",
+		"    Some Content",
+		"    Multiline content",
+		"=== \"Second Tab\"",
+		"    More content",
+		"    Even more content",
+		"",
+		"!!! note \"Custom Admonation Title\"",
+		"    Admonation content."
+		]
+	},
 }

README.md

@@ -1,4 +1,4 @@
-# NesI support documentation
+# NeSI support documentation
 
 [![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/nesi/support-docs?quickstart=1)
 

checks/run_meta_check.py

@@ -27,7 +27,7 @@
 # Warning level for missing parameters.
 EXPECTED_PARAMETERS = {
     "title": "",
-    "template": ["main.html", "supported_apps.html"],
+    "template": ["main.html", "supported_apps.html", "get_support.html"],
     "description": "",
     "icon": "",
     "status": ["new", "deprecated"],

docs/CONTRIBUTING.md

@@ -1,4 +1,4 @@
 ---
 title: Contributing
 ---
 
@@ -12,7 +12,7 @@
 
 ## Minor edits through GitHub
 
-- Open the GitHub page of the repository, i.e. https://github.com/nesi/support-docs, and find the support page you want to edit.
+- Open the GitHub page of the repository, i.e. [https://github.com/nesi/support-docs](https://github.com/nesi/support-docs), and find the support page you want to edit.
 - Then click on the edit icon or press <kbd>e</kbd> to open the integrated editor.
 - In the integrated editor, use the `preview` tab to check the rendered version.  
   **Note:** Be aware that, unfortunately, the GitHub preview won't render properly some elements, in particular admonitions.
@@ -23,14 +23,30 @@
 
 ## Major edits through GitHub
 
+### Codespace Environment
+
 This repository has been configured to be useable with [GitHub Codespaces](https://github.com/features/codespaces).
 It allows acessing a full featured pre-configured development environment remotely, without installing anything on your local machine.
 
 Clicking on the following link will open a VS Code instance ready to be used with the latest version of the documentation files.
 
 [![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/nesi/support-docs?quickstart=1)
 
+### Sharing Codespace Deployment
+
+Branch deployments can be shared
+
+1. Open 'PORTS' Tab.
+
+2. Right click on the port and select in the menu, 'Port Visiblity' -> 'Public'.
+
+3. Copy forwarded address (<kbd>ctrl</kbd> + <kbd>c</kbd>)
+
+![share codespace](assets/images/shareCodespaceDeployment.png)
+
+Sharing this address will allow other people to view your deployment, so long as your codespace is running.
+
 ## Local Development Environment
 
 A local development environment is not required to make doc edits, but if you are making lots of changes, the real time rendering can be quite helpful.
 
@@ -81,6 +97,13 @@
 
 Custom snippets can be added in <a href="https://github.com/nesi/support-docs/blob/main/.vscode/includes.code-snippets.json">`../.vscode/includes.code-snippets`</a>
 
+#### Command Palette
+
+Pressing <kbd>ctrl</kbd> + <kbd>shift</kbd> + <kbd>p</kbd>, will open up the VSCode _command pallet_.
+This allows you access to all functionality within VS Code, with only a few key presses.
+
+![alt text](assets/images/code_command_pallete.png)
+
 #### Tasks
 
 Some of the same checks run during the GitHub CI, can also be run in VS Code.
@@ -89,6 +112,13 @@
 
 Tasks allow continuous checks to be run in the background, these can be defined in <a href="https://github.com/nesi/support-docs/blob/main/.vscode/tasks.json">`../.vscode/tasks.json`</a>, also include in <a href="https://github.com/nesi/support-docs/blob/main/.vscode/settings.json">`../.vscode/settings.json`</a> in order to trigger on save.
 
+## Checks
+
+Whenever a change is commited, or a merge request opened, a series of automatic checks will be started.
+From a pull request, the status of these checks can be seen in the 'Checks' tab, or inline under the 'Files Changed' Tab.
+
+Will give three levels of ourput, **Errors** (serious issues that will prevent merging into main), **Warnings** (non-critical suggestions for improvement) and **Info** (pedantry).
+
 ## Making a Merge Request
 
 The `main` branch is protected, changes can be made via a pull request.
@@ -122,10 +152,28 @@
 
 Clicking on the 'Files Changed' tab, will give a convenient diff of the changes, as well as inline errors identified by the CI checks.
 
 If some of the CI checks failed (make sure they are not important ones), you will have to click the  `Merge without waiting for requirements to be met (bypass branch protections)` button before proceeding with the merge.
 
 Feel free to raise an issue, make a proposal or [add words to the dictionary](#adding-words-to-dictionary) if you feel you are being unfairly targeted by the CI checks.
 
+## Schedule A Merge Request
+
+Any request can be scheduled to automatically merge at a certain time by adding the following to your merge request message.
+
+```md
+/schedule <datetime>
+```
+
+Where <datetime> is [any string that can be parsed by `Date()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/parse)
+
+e.g.
+
+```md
+/schedule Wednesday
+/schedule 01-05-2024
+/schedule 20240501T160000
+```
+
 ## Update Remote Assets
 
 Certain files need to be fetched from other repos for up to date info. This will be automated, but for not the proccess is manual.
@@ -143,7 +191,7 @@
 
 ## Raise an issue
 
 *Not documented at the moment (TODO)*
 
 ## The 'Supported Apps' Page
 

docs/Getting_Started/Accounts-Projects_and_Allocations/Applying_to_join_an_existing_NeSI_project.md

@@ -5,7 +5,7 @@
 - project
 - request_membership
 - mynesi
 title: Applying to join an existing NeSI project
 vote_count: 0
 vote_sum: 0
 zendesk_article_id: 360000693896
@@ -18,17 +18,14 @@
 
 ## How to join an existing project on NeSI
 
-1. Make sure you have been given the project code by the project owner.
-2. Log in to [my.nesi.org.nz](https://my.nesi.org.nz/).
-3. Under the [Projects](https://my.nesi.org.nz/projects/join) page use
-    the "**Join Project**" link to request to be added to the project as
-    a member.
+You need to contact the owner of the project you would like to join, and provide your NeSI account Username.
 
-Once submitted you will receive a ticket confirmation via email.
+If you do not know your NeSI account username:
+1. Log in to [my.nesi.org.nz](https://my.nesi.org.nz/) via your browser.
+2. In the left side panel, under Account, click My HPC Account. Your Username will appear at the top of the page.
+   ![authentication\_factor\_setup.png](../../assets/images/Setting_Up_and_Resetting_Your_Password.png)
 
 !!! prerequisite "What Next?"
-     -   The project owner will be notified, and asked to approve your
-         request.
-     -   Once your request has been approved by the project owner and
-         processed by us, you will be able to [set your NeSI account
+     -   The project owner will add your username to the project.
+     -   Once it is done, you will be able to [set your NeSI account
          password](../../Getting_Started/Accessing_the_HPCs/Setting_Up_and_Resetting_Your_Password.md).

docs/Getting_Started/my-nesi-org-nz/Release_Notes_my-nesi-org-nz/my-nesi-org-nz_release_notes_v2-22-0.md

@@ -0,0 +1,33 @@
+---
+created_at: '2024-04-30T19:53:24Z'
+tags:
+- releasenote
+title: my.nesi.org.nz release notes v2.22.0
+---
+
+## New and Improved
+
+- Project Request page updates:
+    - We added additional questions that ask for more background information about your project.
+    - We made the grant selection field easier to use with a drop down list. The list is now searchable.
+    - We added the capability to have more supervisors if needed by adding new members and selecting the supervisor tick box.
+    - We improved the saving feature to avoid losing any values from any draft requests.
+    - We added new fields that ask for more information about the type of storage needed.
+    - We now require the email addresses for grant PI as well as the main supervisor.
+    - We added default values for the project start date, the Mahuika compute units, and the storage fields.
+
+- Allocation renewal updates:
+    - We now ask in the renewal form if this allocation is linked to a grant or not.
+    - We now check that the end date of a grant is after the start date of the allocation request. Only valid grants from previous allocations will be carried forward.
+
+- All support links, including link to release notes, now point to NeSI's new documentation site, docs.nesi.org.nz.
+    All inquiries or feedback should be sent via email to either [email protected] or [email protected].
+
+- For added security, project owners will be asked to review their members every year. A notification banner will be displayed annually as a reminder.
+
+## Fixes
+
+- Users with Mahuika allocations can now see the total compute values used to date in their current allocation, displayed in the project details section of their MyNeSI dashboard (green box at top of page).
+
+If you have any questions about any of the updates or fixes, please
+{% include "partials/support_request.html" %}.