From c7984b15218c5d31dc31f5407e311dc6884bbf07 Mon Sep 17 00:00:00 2001 From: Paige Martin Date: Wed, 7 Aug 2024 11:11:53 +1000 Subject: [PATCH 01/10] Update page titles on getting started --- docs/getting_started/index.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/getting_started/index.md b/docs/getting_started/index.md index e12dbc643..05b80da9c 100644 --- a/docs/getting_started/index.md +++ b/docs/getting_started/index.md @@ -1,4 +1,4 @@ -# Getting Started +# Getting Set Up on NCI
@@ -6,7 +6,7 @@ First Steps
- First Steps + Set Up and Customize your NCI Account
From e1bf7b1b2d2d17baded74716d572af265e457489 Mon Sep 17 00:00:00 2001 From: Paige Martin Date: Wed, 7 Aug 2024 11:12:20 +1000 Subject: [PATCH 02/10] update title and minor wording in text --- docs/getting_started/are.md | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/docs/getting_started/are.md b/docs/getting_started/are.md index 2873db529..090ee2061 100644 --- a/docs/getting_started/are.md +++ b/docs/getting_started/are.md @@ -1,18 +1,17 @@ # Australian Research Environment (ARE) -[ARE](https://are.nci.org.au) is a web-based graphical interface for performing your computational research, provided by [NCI](https://nci.org.au/).
-ARE can give you access to NCI’s _Gadi_ supercomputer and data collections. +ARE is a web-based graphical interface for performing your computational research, provided by NCI. +ARE gives you access to NCI’s Gadi supercomputer and data collections. There are multiple applications included in ARE, but the two most used for ACCESS-related activities are [Virtual Desktop (VDI)](#vdi) and [JupyterLab](#jupyterlab). ## Prerequisites -To use ARE, you must have an NCI account and be a member of a project with computing resources (SU).
-If you are new to ACCESS, follow the [First Steps](/getting_started/first_steps). +To use ARE, you must have an NCI account and be a member of a project with computing resources (known as Service Units, or SU). For instructions on how to set up an account and join projects, see Set Up and Customize your NCI Account. ## Start an ARE session
- +
From 62f0668cea71d6d0161c3f6ad696b13794173795 Mon Sep 17 00:00:00 2001 From: Paige Martin Date: Wed, 7 Aug 2024 11:12:42 +1000 Subject: [PATCH 03/10] update title --- docs/getting_started/first_steps.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/getting_started/first_steps.md b/docs/getting_started/first_steps.md index e8a01bfc3..3e8f73955 100644 --- a/docs/getting_started/first_steps.md +++ b/docs/getting_started/first_steps.md @@ -1,4 +1,4 @@ -# First Steps +# Set Up and Customize your NCI Account The steps in this section are aimed at new users who would like to do any of the following tasks: From b5c50dd8762258ebb0caa68c8c629a9ac41ddcaa Mon Sep 17 00:00:00 2001 From: Paige Martin Date: Wed, 7 Aug 2024 16:13:14 +1000 Subject: [PATCH 04/10] update getting started on homepage --- docs/index.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/index.md b/docs/index.md index bcc045a1b..601fc97f6 100644 --- a/docs/index.md +++ b/docs/index.md @@ -17,9 +17,9 @@ hide:
-
New to ACCESS-Hive?
+
New to NCI?
-
Get Started
+
Get Started on NCI
 From 584e2db6b4d967af0d463f5ba982fc6dcf02ccf2 Mon Sep 17 00:00:00 2001 From: Paige Martin Date: Wed, 7 Aug 2024 16:13:32 +1000 Subject: [PATCH 05/10] update titles in table of contents --- mkdocs.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/mkdocs.yml b/mkdocs.yml index fb699dd63..2455868ff 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -97,9 +97,9 @@ nav: - Home: - index.md - - Getting Started: + - Get Started on NCI: - getting_started/index.md - - First Steps: getting_started/first_steps.md + - Set Up and Customize your NCI Account: getting_started/first_steps.md - Australian Research Environment (ARE): getting_started/are.md - Models: From b23252a205119d15fb1472e90faa0c9369d4e919 Mon Sep 17 00:00:00 2001 From: Paige Martin Date: Wed, 7 Aug 2024 16:13:53 +1000 Subject: [PATCH 06/10] update title of first steps --- docs/getting_started/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/getting_started/index.md b/docs/getting_started/index.md index 05b80da9c..e8cd991fe 100644 --- a/docs/getting_started/index.md +++ b/docs/getting_started/index.md @@ -1,4 +1,4 @@ -# Getting Set Up on NCI +# Get Started on NCI
From ba4745866fcef03a932f8288ed88f57482c2a2a5 Mon Sep 17 00:00:00 2001 From: Paige Martin Date: Thu, 8 Aug 2024 10:21:42 +1000 Subject: [PATCH 07/10] Apply suggestions from code review Co-authored-by: Davide Marchegiani --- docs/getting_started/are.md | 4 ++-- docs/getting_started/first_steps.md | 2 +- docs/getting_started/index.md | 4 ++-- mkdocs.yml | 4 ++-- 4 files changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/getting_started/are.md b/docs/getting_started/are.md index 090ee2061..3b17dcf62 100644 --- a/docs/getting_started/are.md +++ b/docs/getting_started/are.md @@ -1,7 +1,7 @@ # Australian Research Environment (ARE) -ARE is a web-based graphical interface for performing your computational research, provided by NCI. -ARE gives you access to NCI’s Gadi supercomputer and data collections. +[ARE](https://are-auth.nci.org.au) is a web-based graphical interface for performing your computational research, provided by [NCI](https://nci.org.au).
+ARE gives you access to NCI’s _Gadi_ supercomputer and data collections. There are multiple applications included in ARE, but the two most used for ACCESS-related activities are [Virtual Desktop (VDI)](#vdi) and [JupyterLab](#jupyterlab). diff --git a/docs/getting_started/first_steps.md b/docs/getting_started/first_steps.md index 3e8f73955..6137ccd42 100644 --- a/docs/getting_started/first_steps.md +++ b/docs/getting_started/first_steps.md @@ -1,4 +1,4 @@ -# Set Up and Customize your NCI Account +# Set Up your NCI Account The steps in this section are aimed at new users who would like to do any of the following tasks: diff --git a/docs/getting_started/index.md b/docs/getting_started/index.md index e8cd991fe..6c760b548 100644 --- a/docs/getting_started/index.md +++ b/docs/getting_started/index.md @@ -1,4 +1,4 @@ -# Get Started on NCI +# Getting Started
@@ -6,7 +6,7 @@ First Steps
- Set Up and Customize your NCI Account + Set Up your NCI Account
diff --git a/mkdocs.yml b/mkdocs.yml index 2455868ff..02b2c257e 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -97,9 +97,9 @@ nav: - Home: - index.md - - Get Started on NCI: + - Getting Started - getting_started/index.md - - Set Up and Customize your NCI Account: getting_started/first_steps.md + - Set Up your NCI Account: getting_started/first_steps.md - Australian Research Environment (ARE): getting_started/are.md - Models: From 31d07d737ffb2c20c6c0369cc0638b6a74dbe062 Mon Sep 17 00:00:00 2001 From: Paige Martin Date: Wed, 21 Aug 2024 12:35:44 +1000 Subject: [PATCH 08/10] Update docs/index.md Co-authored-by: Felicity Chun <32269066+flicj191@users.noreply.github.com> --- docs/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/index.md b/docs/index.md index 601fc97f6..9104d0dab 100644 --- a/docs/index.md +++ b/docs/index.md @@ -17,7 +17,7 @@ hide:
-
New to NCI?
+
New ACCESS user?
Get Started on NCI
From 050463c2317f6960fc2c49e8d799292365d00408 Mon Sep 17 00:00:00 2001 From: Paige Martin Date: Wed, 21 Aug 2024 12:40:25 +1000 Subject: [PATCH 09/10] add short description on getting started page --- docs/getting_started/index.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/getting_started/index.md b/docs/getting_started/index.md index 6c760b548..8515c46e4 100644 --- a/docs/getting_started/index.md +++ b/docs/getting_started/index.md @@ -1,5 +1,7 @@ # Getting Started +If you have never used NCI Gadi for ACCESS models, run through these two pages to get set up. If you already have an NCI account but have never used ARE, it is a web-based interface to Gadi that is useful for many ACCESS-related activities. +
@@ -17,4 +19,4 @@ Australian Research Environment (ARE)
-
\ No newline at end of file +
From f6002544552ef267e5aad63eb21dbfd89e6a0852 Mon Sep 17 00:00:00 2001 From: Felicity Chun <32269066+flicj191@users.noreply.github.com> Date: Wed, 21 Aug 2024 13:09:05 +1000 Subject: [PATCH 10/10] update missing : --- mkdocs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/mkdocs.yml b/mkdocs.yml index 02b2c257e..ba56cdba4 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -97,7 +97,7 @@ nav: - Home: - index.md - - Getting Started + - Getting Started: - getting_started/index.md - Set Up your NCI Account: getting_started/first_steps.md - Australian Research Environment (ARE): getting_started/are.md