Skip to content
This repository was archived by the owner on Mar 29, 2022. It is now read-only.

Commit 5c73609

Browse files
committed
fixing broken links
1 parent 66ee5ca commit 5c73609

9 files changed

+19
-19
lines changed

docs/01.create_client.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ tagline:
77
[The Agave API](http://developer.tacc.cloud/), (a component of the SD2E API), is
88
used to configure your user environment to interact with the SD2E platform. If
99
you do not yet have the CLI installed and in your `$PATH`, first go
10-
[here](01.02.install_cli.md) to install it.
10+
[here](01.install_cli.md) to install it.
1111

1212
<br>
1313
#### Initiate with the SD2E Agave tenant

docs/01.ssh_keys.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,14 @@ tagline:
66

77
In certain circumstances, it is advantageous to use public / private SSH keys
88
to authenticate with the Agave API. Specifically, this is important when
9-
[creating your own private systems](02.06.create_systems.md). Having SSH keys
9+
[creating your own private systems](02.create_systems.md). Having SSH keys
1010
will make it easier to interact with systems that do not allow password
1111
authentication or that require frequent password changes, and it will increase
1212
security by preventing the need to store your password in a plain text file.
1313

1414
If you are new to the Agave CLI and the SD2E Agave tenant, it is recommended to
1515
skip this section of the documents until you need to
16-
[create your own private systems](02.06.create_systems.md).
16+
[create your own private systems](02.create_systems.md).
1717

1818
<br>
1919
#### Prerequisites
@@ -76,7 +76,7 @@ Finally, add your public key to the `authorized_keys` file on your remote system
7676
[js-104-39] % cat agave_rsa.pub >> ~/.ssh/authorized_keys
7777
```
7878
Your private key (`agave_rsa`) will be used in the future when it is time to
79-
[create your own private systems](02.06.create_systems.md). Never share your
79+
[create your own private systems](02.create_systems.md). Never share your
8080
private key with anyone else.
8181

8282

docs/02.create_systems.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ tagline:
66

77
Most standard SD2E API users will not need to create custom execution or storage
88
systems. By default, you have access to some private and public execution and
9-
storage systems that should connect you to [most of TACC resources](02.01.systems_basics.md).
9+
storage systems that should connect you to [most of TACC resources](02.systems_basics.md).
1010

1111
Even so, there are circumstances where it is advantageous to create your own systems.
1212
For example, they can help you connect to private lab servers, license servers,
@@ -19,7 +19,7 @@ and execution system.
1919

2020
For any system you register with Agave, you need the hostname and login credentials.
2121
The preferred login credentials are SSH key pairs. For instructions on creating
22-
appropriate public / private keys, see [here](01.05.ssh_keys.md).
22+
appropriate public / private keys, see [here](01.ssh_keys.md).
2323

2424
You also need some basic information on the compute resources which will be
2525
registered as systems. For storage systems, you need to know the desired path
@@ -29,7 +29,7 @@ information about the queueing system (queue names, limits, etc.). For both type
2929
of execution system you need a path for running jobs.
3030

3131
The Jetstream instance we will register has hostname `129.114.104.39`. We will
32-
assume the user '`username`' has already created [SSH keys](01.05.ssh_keys.md)
32+
assume the user '`username`' has already created [SSH keys](01.ssh_keys.md)
3333
and added the public key to `~/.ssh/known_hosts/`. The path for storing data
3434
will be the home directory, `/home/username/`. Since this instance does not have
3535
a queuing system, we will register it as a CLI execution system and run jobs

docs/02.data_management.mdd renamed to docs/02.data_management.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ list files, upload and download data, remotely manage and organize data, and imp
1010
external data from the web.
1111

1212
Agave `files-*` commands act on Agave storage systems. See the
13-
[systems basics](02.01.systems_basics.md) documentation for more details.
13+
[systems basics](02.systems_basics.md) documentation for more details.
1414

1515
This page is broken down into the following sections:
1616

@@ -57,7 +57,7 @@ WARNING: The `files-delete` command will delete folders with or without contents
5757

5858
*Tip: if you set `data-tacc-work-username` as your default system, then you
5959
do not need to provide it on the command line. More info
60-
[here](02.01.systems_basics.md).*
60+
[here](02.systems_basics.md).*
6161

6262
<br>
6363
#### Uploading and downloading via the CLI
@@ -143,7 +143,7 @@ more descriptive information (when applicable) related to number of retries, per
143143
grants and revocations, reasons for failure, and hiccups that may have occurred in
144144
the transfer process.
145145
```
146-
% files-history -S data-tacc-work-username sd2e-data/my_copy.txt
146+
% files-history -S data-tacc-work-username sd2e-data/my_copy.txt
147147
File item copied from https://api.sd2e.org/files/v2/media/system/data-tacc-work-username//sd2e-data/my_file.txt
148148
```
149149

docs/02.find_application.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -366,8 +366,8 @@ However, this is an important clue (along with the inputs, parameters, and app
366366
description) to indicate what is the function of this app.
367367

368368
Once the appropriate app has been identified, the next steps are to
369-
[stage the input data](02.02.data_management.md), and to
370-
[prepare and submit a job](02.05.submit_job).
369+
[stage the input data](02.data_management.md), and to
370+
[prepare and submit a job](02.submit_job).
371371

372372
---
373373
Return to the [API Documentation Overview](../index.md)

docs/02.modify_systems.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: Modify Existing Systems
44
tagline:
55
---
66

7-
Agave [systems](02.06.create_systems.md) are described by `json` files and added
7+
Agave [systems](02.create_systems.md) are described by `json` files and added
88
to the SD2E tenant using the command line interface. To modify a system after it
99
has been added, simply edit the original `json` file and use the command line
1010
interface to push the changes to the SD2E tenant.
@@ -14,7 +14,7 @@ interface to push the changes to the SD2E tenant.
1414
#### Modify an Agave system
1515

1616
This is an example Agave storage system `json` file from an
17-
[earlier section](02.06.create_systems.md) of this user guide:
17+
[earlier section](02.create_systems.md) of this user guide:
1818
```
1919
{
2020
"id": "jetstream-storage-username",

docs/02.submit_job.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ tagline:
55
---
66

77
Continuing with the previous example of kallisto (see
8-
[Find an Application](02.04.find_application.md)), we know there are three
8+
[Find an Application](02.find_application.md)), we know there are three
99
required input files, one required input parameter, and two optional input
1010
parameters for this specific application.
1111

@@ -120,7 +120,7 @@ transcripts.fasta.gz
120120
Because this job had attribute `"archive":true` in the job template, the output
121121
files were archived in your `tacc-work` space under a folder named after your
122122
username. A copy of the output also remains in the jobs API space for easy access
123-
and, if desired, chaining into other jobs. The important output for this
123+
and, if desired, chaining into other jobs. The important output for this
124124
particular job is all located in the `output` subdirectory. Download just the
125125
`output` subdirectory using the following command:
126126
```

docs/02.systems_basics.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ hostname. They may be public or private, and they may either be **storage** syst
1010

1111
In SD2E, we provide all users with private storage and execution systems attached to
1212
TACC resources. If you would like to create your own systems attached to different
13-
resources, skip ahead to [Create Private Systems](02.06.create_systems.md).
13+
resources, skip ahead to [Create Private Systems](02.create_systems.md).
1414

1515

1616
<br>
@@ -257,7 +257,7 @@ information about queue types and availability.
257257
<br>
258258
#### Set a default system
259259

260-
You may find that most of the [file operations](02.02.data_management.md) you
260+
You may find that most of the [file operations](02.data_management.md) you
261261
perform are against your private TACC storage system - `data-tacc-work-username`.
262262
To avoid typing the full name of the system with every file command, you may set
263263
it as the default system with:

docs/03.modify_applications.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: Modify Existing Systems and Applications
44
tagline:
55
---
66

7-
Agave [systems](02.06.create_systems.md) and [apps](03.01.create_app.md) are described by
7+
Agave [systems](02.create_systems.md) and [apps](03.create_app.md) are described by
88
`json` files and added to the SD2E tenant using the command line interface. To
99
modify a system or app after it has been added, simply edit the original `json`
1010
file and use the command line interface to push the changes to the SD2E tenant.

0 commit comments

Comments
 (0)