From 19337bef69c4a69beb1c20c6ab47185282b709c1 Mon Sep 17 00:00:00 2001 From: jluethi Date: Fri, 20 Dec 2024 17:34:02 +0100 Subject: [PATCH] Fix broken link --- docs/tasks_spec.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/tasks_spec.md b/docs/tasks_spec.md index 95b7634..b9114fc 100644 --- a/docs/tasks_spec.md +++ b/docs/tasks_spec.md @@ -63,7 +63,7 @@ python src/my-pkg/dev/create_manifest.py generates a JSON file with the up-to-date manifest. Note that advanced usage may require minor customizations of the create-manifest script. ### Manifest metadata -The task manifest can contain additional metadata that makes it easier for people to browse tasks on the [Fractal task page](#./fractal_tasks.md) and the tasks available on a given server. The [Fractal task template](https://github.com/fractal-analytics-platform/fractal-tasks-template) provides good defaults for how all this metadata can be set. This metadata is also used to make tasks searchable. +The task manifest can contain additional metadata that makes it easier for people to browse tasks on the [Fractal task page](./fractal_tasks.md) and the tasks available on a given server. The [Fractal task template](https://github.com/fractal-analytics-platform/fractal-tasks-template) provides good defaults for how all this metadata can be set. This metadata is also used to make tasks searchable. #### Docs info Tasks can provide a structured summary of their functionality. If the image list does not contain a docs_info property for a given task, the docstring of the task function is used. A developer can provide a more structured markdown file by specifying the relative path to the markdown file with the task description (for example: `file:task_info/task_description.md`). The convention for these task descriptions is to contain a section on the purpose of the task as well as its limitations in a bullet-point list. @@ -81,7 +81,7 @@ Tasks can have arbitrary lists of string tags that describe their functionality. Task packages can specify an authors list. This metadata is configured in the create_manifest.py script for the whole task package. ### How to get your task package on the Fractal tasks page -If you have a task package that you would like to see listed on the [Fractal task page](#./fractal_tasks.md) page, ping one of the Fractal maintainers about it or [make a PR to have your task included in the list of task sources here](https://github.com/fractal-analytics-platform/fractal-analytics-platform.github.io/blob/main/tasks_data_retrieval/sources.txt). For a task package to be listable on the Fractal tasks page, the package needs to contain a Fractal manifest and be available either via PyPI or via a whl in Github releases. The [Fractal task template](https://github.com/fractal-analytics-platform/fractal-tasks-template) provides examples for how to do both. +If you have a task package that you would like to see listed on the [Fractal task page](./fractal_tasks.md) page, ping one of the Fractal maintainers about it or [make a PR to have your task included in the list of task sources here](https://github.com/fractal-analytics-platform/fractal-analytics-platform.github.io/blob/main/tasks_data_retrieval/sources.txt). For a task package to be listable on the Fractal tasks page, the package needs to contain a Fractal manifest and be available either via PyPI or via a whl in Github releases. The [Fractal task template](https://github.com/fractal-analytics-platform/fractal-tasks-template) provides examples for how to do both. Future work will add support for adding additional task configurations (likely a specification for how to provide packages that are installable via Pixi).