Skip to content

Commit 7b267ea

Browse files
committed
DOC: Use more canonical links in docs
skipci
1 parent 3a773c1 commit 7b267ea

17 files changed

+40
-40
lines changed

docs/authentication.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Authentication is provided by a GCP service account.
88
## Creating a service account
99

1010
By setting up your Twined service network with the
11-
[Twined Terraform modules](/deploying_services), a set of maintainer service accounts have already been
11+
[Twined Terraform modules](core_concepts/deploying_services.md), a set of maintainer service accounts have already been
1212
created with the required permissions. These will have names starting with `maintainer-`.
1313

1414
## Using a service account

docs/core_concepts/asking_questions.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ to a child for processing/analysis. Questions can be:
2121
or custom logic in your own webserver.
2222

2323
Questions are always asked to a _revision_ of a service. You can ask a
24-
service a question if you have its [SRUID](../services/#service-names), project ID, and the necessary permissions.
24+
service a question if you have its [SRUID](services.md/#service-names), project ID, and the necessary permissions.
2525

2626
## Asking a question
2727

@@ -49,7 +49,7 @@ answer["output_manifest"]["my_dataset"].files
4949

5050
If you're using an environment other than the `main` environment, then before asking any questions to your Twined
5151
services, set the `TWINED_SERVICES_TOPIC_NAME` environment variable to the name of the Twined services Pub/Sub topic
52-
(this is set when [deploying a service network](../deploying_services/#deploying-services-advanced-developers-guide).
52+
(this is set when [deploying a service network](deploying_services.md).
5353
It will be in the form `<environment-name>.octue.twined.services`
5454

5555
!!! note
@@ -242,10 +242,10 @@ at once instead of one after another.
242242
## Asking a question within a service
243243

244244
If you have
245-
[created your own Twined service](../creating_services) and want to ask children questions, you can do this more
245+
[created your own Twined service](creating_services.md) and want to ask children questions, you can do this more
246246
easily than above. Children are accessible from the `analysis` object by
247247
the keys you give them in the
248-
[service configuration](../creating_services/#octueyaml) file. For example, you can ask an `elevation` service a
248+
[service configuration](creating_services.md/#octueyaml) file. For example, you can ask an `elevation` service a
249249
question like this:
250250

251251
```python
@@ -314,7 +314,7 @@ you want it to use (dynamic children) to the
314314
children will instead go to the dynamic children. Note that:
315315

316316
- You must provide the children in the same format as they're provided
317-
in the [service configuration](../../core_concepts/creating_services/#octueyaml)
317+
in the [service configuration](../core_concepts/creating_services.md/#octueyaml)
318318
- If you override one static child, you must override others, too
319319
- The dynamic children must have the same keys as the static children
320320
(so the child knows which service to ask which questions)

docs/core_concepts/creating_services.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,12 @@ A Twined service is defined by the following files (located in the repository ro
1616

1717
### app.py
1818

19-
This is the entrypoint into your code - read more [here](../creating_apps).
19+
This is the entrypoint into your code - read more [here](creating_apps.md).
2020

2121
### twine.json
2222

23-
This file defines the schema for the service's configuration, input, and output data. Read more [here](../twines) and
24-
see an example [here](../twine_file_quickstart).
23+
This file defines the schema for the service's configuration, input, and output data. Read more [here](twines.md) and
24+
see an example [here](twine_file_quickstart.md).
2525

2626
### Dependencies file
2727

@@ -98,7 +98,7 @@ are supported.
9898

9999
### Where to specify the namespace, name, and revision tag
100100

101-
See [here](../services/#service-names) for service naming requirements.
101+
See [here](services.md/#service-names) for service naming requirements.
102102

103103
**Namespace**
104104

@@ -149,4 +149,4 @@ Automated deployment with Octue means:
149149
other services are sent to it, meaning there are minimal costs to
150150
having it deployed but not in use.
151151

152-
If you'd like help deploying services, [contact us](../../support). To do it yourself, see [here](../deploying_services).
152+
If you'd like help deploying services, [contact us](../support.md). To do it yourself, see [here](deploying_services.md).
File renamed without changes.

docs/core_concepts/data_containers/datafiles.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ Datafile content isn't downloaded until you:
5151
- Call its `download` method
5252
- Use its `local_path` property
5353

54-
Read more about downloading files [here](../../downloading_datafiles).
54+
Read more about downloading files [here](downloading_datafiles.md).
5555

5656
### CLI command friendly
5757

docs/core_concepts/data_containers/datasets.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -202,7 +202,7 @@ dataset.files.filter(extension="csv", labels__contains="a")
202202
>>> <FilterSet({<Datafile('my_file.csv')>})>
203203
```
204204

205-
For the full list of available filters, [click here](../../available_filters).
205+
For the full list of available filters, [click here](available_filters.md).
206206

207207
### Order datasets
208208

docs/core_concepts/data_containers/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
One of the main features of Twined is making using, creating, and
44
sharing scientific datasets easy. There are three main data classes that do this:
55

6-
- **Datafile** - [a single local or cloud file](datafiles) and its metadata.
7-
- **Dataset** - [a set of related datafiles](datasets) that exist in the same location, plus metadata.
8-
- **Manifest** - [a set of related datasets](manifests) that exist anywhere, plus metadata. Typically produced by or for
6+
- **Datafile** - [a single local or cloud file](datafiles.md) and its metadata.
7+
- **Dataset** - [a set of related datafiles](datasets.md) that exist in the same location, plus metadata.
8+
- **Manifest** - [a set of related datasets](manifests.md) that exist anywhere, plus metadata. Typically produced by or for
99
one analysis.

docs/core_concepts/data_containers/manifests.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
!!! tip
44

5-
Use a manifest to send [datasets](../datasets) to a Twined service as a question (for processing) - the
5+
Use a manifest to send [datasets](datasets.md) to a Twined service as a question (for processing) - the
66
service will send an output manifest back with its answer if the answer includes output datasets.
77

88
## Key features
@@ -39,7 +39,7 @@ child = Child(
3939
answer, question_uuid = child.ask(input_manifest=manifest)
4040
```
4141

42-
See [here](../../asking_questions) for more information.
42+
See [here](../asking_questions.md) for more information.
4343

4444
### Receive datasets from a service
4545

docs/core_concepts/deploying_services.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ done automatically:
4242
including automated pre-deployment testing and creation of a GitHub
4343
release
4444

45-
You can now [ask your service some questions](../asking_questions)! It will be available in the service network as
45+
You can now [ask your service some questions](asking_questions.md)! It will be available in the service network as
4646
`<namespace>/<name>:<version>` (e.g. `octue/example-service-kueue:0.1.1`).
4747

4848
## Deploying the infrastructure

docs/core_concepts/running_services_locally.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ processing). You can:
1313
### Via the CLI
1414

1515
1. Ensure you've created a valid
16-
[`octue.yaml`](../../core_concepts/creating_services/#octueyaml)
16+
[`octue.yaml`](../core_concepts/creating_services.md/#octueyaml)
1717
file for your service
1818

1919
2. Run:
@@ -50,7 +50,7 @@ See the `Runner` API documentation for more advanced usage including providing c
5050
### Via the CLI
5151

5252
1. Ensure you've created a valid
53-
[`octue.yaml`](../../core_concepts/creating_services/#octueyaml)
53+
[`octue.yaml`](../core_concepts/creating_services.md/#octueyaml)
5454
file for your service
5555

5656
2. Run:

0 commit comments

Comments
 (0)