Skip to content

Commit

Permalink
Check broken-links in CI (#24)
Browse files Browse the repository at this point in the history
* Check broken-links in CI

* Fix broken links

* fix ci script
  • Loading branch information
corentinmusard authored Oct 29, 2024
1 parent f5ba01e commit 8a5bd2d
Show file tree
Hide file tree
Showing 7 changed files with 23 additions and 8 deletions.
15 changes: 15 additions & 0 deletions .github/workflows/lint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,3 +12,18 @@ jobs:
- uses: errata-ai/vale-action@reviewdog
with:
fail_on_error: true
docs-quality:
name: Check docs standards
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
lfs: true
- name: Setup Node
uses: actions/setup-node@v4
with:
node-version: 20
- name: Install Mintlify CLI
run: npm install -g mintlify
- name: Run Mintlify broken-links
run: mintlify broken-links
2 changes: 1 addition & 1 deletion api-reference/workflows/creating-task-runner.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: How to create a task runner
icon: list-check
---

From a [client instance](/workflows/creating) you can create a [TaskRunner](/workflows/concepts/task-runners), capable of executing tasks.
From a client instance you can create a [TaskRunner](/workflows/concepts/task-runners), capable of executing tasks.

<RequestExample>

Expand Down
2 changes: 1 addition & 1 deletion api-reference/workflows/submitting-job.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: How to submit a job
icon: diagram-project
---

To execute a workflow, you first need to submit a [job](/workflow/jobs) to the Tilebox API.
To execute a workflow, you first need to submit a [job](/workflows/concepts/jobs) to the Tilebox API.
This can be done by calling the `submit` method of a `JobClient` instance.

<RequestExample>
Expand Down
2 changes: 1 addition & 1 deletion api-reference/workflows/task-inputs.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: How to define task inputs
icon: laptop-code
---

A task can optionally define [input parameters](/workflow/tasks#input-parameters).
A task can optionally define [input parameters](/workflows/concepts/tasks#input-parameters).
These parameters are defined as class attributes, the same way as you would define a dataclass.

<RequestExample>
Expand Down
2 changes: 1 addition & 1 deletion datasets/introduction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ Here are some terms used throughout this section.

Prerequisites

- You've [installed](/sdks/python/installation) the `tilebox-datasets` package
- You've [installed](/sdks/python/install) the `tilebox-datasets` package
- You've [created](/authentication) a Tilebox API key

With the prerequisites out of the way, you can now create a client instance to start interacting with your Tilebox Datasets.
Expand Down
4 changes: 2 additions & 2 deletions workflows/concepts/clusters.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Before registering a task runner, or submitting a job, you need to create a clus
clusters as needed. The following sections illustrates how to do this.

To manage clusters, you first need to instantiate a cluster client. You can do this by calling the `clusters` method on the
[workflows' client](/workflows/creating).
workflows' client.

<CodeGroup title="Instantiating a Clusters Client">
```python Python (Sync)
Expand Down Expand Up @@ -132,7 +132,7 @@ To delete a cluster, you can use the `delete` method and pass in a cluster's slu

## Jobs spanning different clusters

[When submitting a job](/workflows/job) you need to specify the cluster that the job should be submitted to.
[When submitting a job](/workflows/concepts/jobs) you need to specify the cluster that the job should be submitted to.
This allows you to target a specific group of task runners for a particular job. All sub-tasks within the job are
submitted to the same cluster by default. This can also be manually overridden to submit sub-tasks to other
clusters if needed. Check out the example below to see how this can be done.
Expand Down
4 changes: 2 additions & 2 deletions workflows/concepts/jobs.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Once a job is submitted, its root task is scheduled for execution, and any [elig
may pick it up and execute it.

For submitting a job, a job client needs to be instantiated first. This can be done by calling the `jobs` method on the
[workflows' client](/workflows/creating).
workflows' client.

<CodeGroup>
```python Python (Sync)
Expand Down Expand Up @@ -115,7 +115,7 @@ and [dependencies](/workflows/concepts/tasks#dependencies), it's possible to vis
Assuming you have submitted a job, you can use the `display` method on the job client to display the execution of the job as a graph diagram.

<Note>
The `display` method is designed to be used in an [interactive environment](/sdks/python/jupyter), such as a Jupyter notebook.
The `display` method is designed to be used in an [interactive environment](/sdks/python/sample-notebooks#interactive-environments), such as a Jupyter notebook.
In non-interactive environments, use `job_client.visualize` instead which returns the rendered diagram as a string
in the SVG format.
</Note>
Expand Down

0 comments on commit 8a5bd2d

Please sign in to comment.