Skip to content

Commit b1ba08d

Browse files
authored
consistent internal links (#23)
convert all internal links to use the "ref-" prefix
1 parent 3986e41 commit b1ba08d

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

41 files changed

+133
-112
lines changed

docs/access/index.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,32 +4,32 @@ This documentation guides users through the process of accessing CSCS systems an
44

55
!!! note ""
66
Before accessing CSCS, you need to have an account at CSCS, and be part of a project that has been allocated resources.
7-
More information on how to get an account is available in [accounts and projects][account-management].
7+
More information on how to get an account is available in [accounts and projects][ref-account-management].
88

99
<div class="grid cards" markdown>
1010

1111
- :fontawesome-solid-layer-group: __Multi Factor Authentification__
1212

1313
Before signing in to CSCS' web portals or using SSH, all users have to set up multi factor authentification (MFA)
1414

15-
[:octicons-arrow-right-24: MFA][mfa]
15+
[:octicons-arrow-right-24: MFA][ref-mfa]
1616

1717
- :fontawesome-solid-layer-group: __Web Services__
1818

1919
Before signing in to CSCS' web portals or using SSH, all users have to set up multi factor authentification (MFA)
2020

21-
[:octicons-arrow-right-24: Accessing CSCS web services][access-web]
21+
[:octicons-arrow-right-24: Accessing CSCS web services][ref-access-web]
2222

2323
- :fontawesome-solid-layer-group: __SSH Access__
2424

2525
Logging into Clusters on Alps
2626

27-
[:octicons-arrow-right-24: SSH][access-ssh]
27+
[:octicons-arrow-right-24: SSH][ref-ssh]
2828

2929
- :fontawesome-solid-layer-group: __VSCode__
3030

3131
How to connect VSCode IDE on your laptop with Alps
3232

33-
[:octicons-arrow-right-24: SSH][access-vscode]
33+
[:octicons-arrow-right-24: SSH][ref-access-vscode]
3434

3535
</div>

docs/access/mfa.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[](){#mfa}
1+
[](){#ref-mfa}
22
# Multi Factor Authentification
33

44
To access CSCS services and systems users are required to authenticate using multi-factor authentication (MFA).
@@ -10,7 +10,7 @@ An OTP is a six-digit number which changes every 30 seconds.
1010
OTPs are generated using a tool installed on a device other than the one used to access CSCS services and infrastructure.
1111
We recommend to use a smartphone with an application such as Google Authenticator to obtain the OTPs.
1212

13-
[](){#mfa-setup}
13+
[](){#ref-mfa-setup}
1414
## Getting Started
1515

1616
When you first log in to any of the CSCS web applications such as UMP, Jupyter, etc., you will be asked to register your device.
@@ -36,7 +36,7 @@ You can download Google Authenticator for your phone:
3636
* :fontawesome-brands-android: Android: on the [Google Play Store](https://play.google.com/store/apps/details?id=com.google.android.apps.authenticator2).
3737
* :fontawesome-brands-apple: iOS: on the [Apple Store](https://play.google.com/store/apps/details?id=com.google.android.apps.authenticator2).
3838

39-
[](){#mfa-configure-otp}
39+
[](){#ref-mfa-configure-otp}
4040
### Configure the Authenticator
4141

4242
Before starting, ensure that the following pre-requisites are satisfied
@@ -78,7 +78,7 @@ In case users lose access to their mobile device/Authenticator OTP, users can re
7878
2. From the login screen, click the "Reset OTP" link below the "LOG IN" button
7979
3. Enter your username and password.
8080
4. On successful validation of user credentials, users will receive an email with a reset credentials link like the one below, click on the link in the email
81-
5. The steps are the same as for the first time you [configured the authenticator][mfa-configure-otp].
81+
5. The steps are the same as for the first time you [configured the authenticator][ref-mfa-configure-otp].
8282

8383
!!! warning
8484
When replacing your smartphone remember to sync the authenticator app before resetting the old smartphone.

docs/access/ssh.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
[](){#access-ssh}
1+
[](){#ref-ssh}
22
# Using SSH
33

4-
Before accessing CSCS clusters using SSH, first ensure that you have [created a user account][account-management] that is part of a project that has access to the cluster, and have [multi factor authentification][mfa] configured.
4+
Before accessing CSCS clusters using SSH, first ensure that you have [created a user account][ref-account-management] that is part of a project that has access to the cluster, and have [multi factor authentification][ref-mfa] configured.
55

6-
[](){#sshservice}
6+
[](){#ref-ssh-service}
77
## Generating Keys with SSHService
88

99
It is not possible to authenticate with a username/password and user-created SSH keys.
@@ -103,7 +103,7 @@ ssh -i ~/.ssh/cscs-key ela.cscs.ch
103103
To log into a target system at CSCS, you need to perform some additional setup to handle forwarding of SSH keys generated using the SSHService.
104104
There are two alternatives detailed below.
105105

106-
[](){#ssh-ssh-config}
106+
[](){#ref-ssh-config}
107107
### Adding Ela as a jump host in SSH Configuration
108108

109109
This approach configures Ela as a jump host and creates aliases for the systems that you want to access in `~/.ssh/config` on your laptop or PC.
@@ -148,12 +148,12 @@ After saving this file, one can directly log into `daint.alps.cscs.ch` from your
148148
ssh daint
149149
```
150150

151-
[](){#ssh-ssh-agent}
151+
[](){#ref-ssh-agent}
152152
### Using SSH Agent
153153

154154
Alternatively, the [SSH authentification agent](https://www.ssh.com/academy/ssh/add-command) can be configured to manage the keys.
155155

156-
Each time a new key is generated using the [SSHService][sshservice], add the key to the SSH agent:
156+
Each time a new key is generated using the [SSHService][ref-ssh-service], add the key to the SSH agent:
157157
```
158158
ssh-add -t 1d ~/.ssh/cscs-key
159159
```

docs/access/vscode.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[](){#access-vscode}
1+
[](){#ref-access-vscode}
22
# Connecting with VSCode
33

44
[Visual Studio Code](https://code.visualstudio.com/) provides flexible support for remote development.
@@ -107,7 +107,7 @@ Once the tunnel is configured, you can access it from VSCode.
107107

108108
!!! warning
109109
If you plan to do any intensive work: repeated compilation of large projects or running python code in Jupyter, please see the guide to running on a compute node below.
110-
Running intensive workloads on login nodes, which are shared resources between all users, is against CSCS [fair usage][policies-fair-use] of Shared Resources policy.
110+
Running intensive workloads on login nodes, which are shared resources between all users, is against CSCS [fair usage][ref-policies-fair-use] of Shared Resources policy.
111111

112112
### Using with containers
113113

docs/access/web.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
1-
[](){#access-web}
1+
[](){#ref-access-web}
22
# Accessing CSCS Web Portals
33

44
Most services at CSCS are connected to the CSCS Single Sign-On gate.
55
This gives users the comfort of not having to sign in multiple times in each individual service connected to this gate and increases security.
66
Furthermore, the Single Sign-On gate allow users to recover their forgotten passwords and authenticate using a third-party account. The login page looks like
77

8-
[](){#web-mfa}
8+
[](){#ref-web-mfa}
99
## Using MFA to acccess web-based services
1010

11-
After having completed the setup of [MFA][mfa], you will be asked to enter your login/password and the OTP to access all web-based services.
11+
After having completed the setup of [MFA][ref-mfa], you will be asked to enter your login/password and the OTP to access all web-based services.
1212

1313
Enter username and password.
1414

docs/accounts/index.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[](){#account-management}
1+
[](){#ref-account-management}
22
# Getting and Managing Accounts
33

44
Users at CSCS have one account that can be used to access all services and systems at CSCS.
@@ -22,11 +22,11 @@ PIs can then invite members of their groups to join their project.
2222

2323
The tool used to manage projects and accounts depends on the platform on which the project was granted:
2424

25-
* The [HPC Platform][hpcp] and [Climate and Weather Platform][cwp] use the [account and resources management tool][ump] at [account.cscs.ch](https://account.cscs.ch)
26-
* The [Machine Learning Platform][mlp] uses the [project and resources management tool][waldur] at [portal.cscs.ch](https://portal.cscs.ch).
25+
* The [HPC Platform][ref-platform-hpcp] and [Climate and Weather Platform][ref-platform-cwp] use the [account and resources management tool][ref-account-ump] at [account.cscs.ch](https://account.cscs.ch)
26+
* The [Machine Learning Platform][ref-platform-mlp] uses the [project and resources management tool][ref-account-waldur] at [portal.cscs.ch](https://portal.cscs.ch).
2727

2828
!!! note
29-
The [portal.cscs.ch][waldur] site will be used to manage all projects in the future.
29+
The [portal.cscs.ch][ref-account-waldur] site will be used to manage all projects in the future.
3030

3131
## Signing up for a new account
3232

docs/accounts/ump.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[](){#ump}
1+
[](){#ref-account-ump}
22
# Account and Resources Management Tool
33

44
The Swiss National Supercomputing Centre (CSCS) offers a web-based tool for users to manage their accounts and projects at [account.cscs.ch](https://account.cscs.ch).

docs/accounts/waldur.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1-
[](){#waldur}
1+
[](){#ref-account-waldur}
22
# The Project and Resources Management Tool
33

44
CSCS Account Managers, PIs and deputy PIs can invite users to the respective projects following the below steps on CSCS's new project management portal.
55

66
!!! info
7-
The new user project management portal is currently only used by the [Machine Learning Platform][mlp]
8-
All other platforms use the old [user management portal](ump.md)
7+
The new user project management portal is currently only used by the [Machine Learning Platform][ref-platform-mlp]
8+
All other platforms use the old [user management portal][ref-account-ump]
99

1010
## log in to the portal
1111

docs/alps/hardware.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[](){#alps-hardware}
1+
[](){#ref-alps-hardware}
22
# Alps Hardware
33

44
Alps is a HPE Cray EX3000 system, a liquid cooled blade-based, high-density system.
@@ -47,27 +47,27 @@ There are currently four node types in Alps, with another becoming available in
4747
| AMD MI250x | 12 | 24 | 24 | 96 |
4848
| AMD MI300A | 64 | 128 | 512 | 512 |
4949

50-
[](){#gh200-node}
50+
[](){#ref-alps-gh200-node}
5151
### NVIDIA GH200 GPU Nodes
5252

5353
Perry Peak
5454

55-
[](){#zen2-node}
55+
[](){#ref-alps-zen2-node}
5656
### AMD Rome CPU Nodes
5757

5858
EX425
5959

60-
[](){#a100-node}
60+
[](){#ref-alps-a100-node}
6161
### NVIDIA A100 GPU Nodes
6262

6363
Grizzly Peak
6464

65-
[](){#mi200-node}
65+
[](){#ref-alps-mi200-node}
6666
### AMD MI250x GPU Nodes
6767

6868
Bard Peak
6969

70-
[](){#mi300-node}
70+
[](){#ref-alps-mi300-node}
7171
### AMD MI300A GPU Nodes
7272

7373
Parry Peak

docs/alps/index.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
[](){#ref-alps}
12
# Alps Infrastructure
23

34
Alps is a general-purpose compute and data Research Infrastructure (RI) open to the broad community of researchers in Switzerland and the rest of the world.
@@ -14,13 +15,13 @@ Additionally, network segregation ensures secure and isolated communication, wit
1415

1516
- :fontawesome-solid-signs-post: __Platforms__
1617

17-
[:octicons-arrow-right-24: Alps Platforms][platforms]
18+
[:octicons-arrow-right-24: Alps Platforms][ref-alps-platforms]
1819

1920
- :fontawesome-solid-signs-post: __Clusters__
2021

2122
The resources on Alps are partitioned and configured into versatile software defined clusters (vClusters).
2223

23-
[:octicons-arrow-right-24: Alps vClusters][clusters]
24+
[:octicons-arrow-right-24: Alps vClusters][ref-alps-clusters]
2425

2526
- :fontawesome-solid-signs-post: __Hardware__
2627

0 commit comments

Comments
 (0)