Skip to content
Snippets Groups Projects
Commit 291f9d45 authored by Yoann Schneider's avatar Yoann Schneider :tennis: Committed by Manon Blanco
Browse files

New documentation structure

parent 86fee1f7
No related branches found
No related tags found
1 merge request!545New documentation structure
Pipeline #172650 passed
Showing
with 77 additions and 21 deletions
......@@ -3,9 +3,6 @@
This page describes how continuous integration (CI) is used in workers created
using the `base-worker` template.
For more information on creating workers, see
[Setting up a worker](../create.md).
## Default template
When creating a worker with our official template, a `.gitlab-ci.yml` file has
......@@ -45,8 +42,7 @@ project and validate various rules:
- Check your YAML files are well formatted
- Fix some common spelling errors
You can set up pre-commit to run locally too; see
[Activating the pre-commit hook](../create.md#activating-the-pre-commit-hook).
You can set up pre-commit to run locally too; see Activating the pre-commit hook.
## Testing
......@@ -59,10 +55,6 @@ allowing you to check the validity of your code before merging it.
Unit tests allow you to prevent regressions in your code when making changes,
and find bugs before they make their way into production.
<!-- TODO:
For more information, see [Writing unit tests for your worker](../tests).
-->
## Building
When the `test` & `lint` jobs run successfully, the `docker` job runs. It will
......
# Tests
!!! warning
This section is under construction.
# Unit tests
!!! warning
This section is under construction.
......@@ -96,8 +96,7 @@ template and making it available on a GitLab instance.
For a worker to be accessible from an Arkindex instance, it needs to be sent
to a repository on a GitLab project. A GitLab project will also allow you to
manage different versions of a worker and run
[automated checks](ci/index.md) on your code.
manage different versions of a worker and run [automated checks](../implem/test/ci.md) on your code.
#### To create a GitLab project
......@@ -211,7 +210,7 @@ This section assumes you have Maintainer or Owner access to the GitLab project.
4. Open your GitLab project in a browser.
5. Click on the blue icon indicating that [CI](ci/index.md)
5. Click on the blue icon indicating that [CI](../implem/test/ci.md)
is running on your repository, and wait for it to turn green to confirm
everything worked.
......
# Initialize your worker
!!! warning
This section is under construction.
......@@ -7,7 +7,7 @@ package, a Docker build, with the best development practices:
`.arkindex.yml`
: YAML configuration file that allows Arkindex to understand what it should do
with this repository.
To learn more about this file, see [YAML configuration](yaml.md).
To learn more about this file, see [YAML configuration](../implem/configure/yaml.md).
`.cookiecutter.yaml`
: YAML file that stores the options you defined when creating a new worker.
......@@ -28,7 +28,7 @@ package, a Docker build, with the best development practices:
`.gitlab-ci.yml`
: Configures the GitLab CI jobs and pipelines.
To learn more about the configuration we provide, see
[GitLab Continuous Integration for workers](ci/index.md).
[GitLab Continuous Integration for workers](../implem/test/ci.md).
`.isort.cfg`
: Configures the automatic Python import sorting rules.
......@@ -50,7 +50,7 @@ package, a Docker build, with the best development practices:
: Configures the worker's Python package.
`ci/build.sh`
: Script that gets run by [CI](ci/index.md) pipelines
: Script that gets run by [CI](../implem/test/ci.md) pipelines
to build the Docker image.
`tests/test_worker.py`
......
# Base Worker
!!! warning
This section is under construction.
# Dataset worker
!!! warning
This section is under construction.
# Element worker
!!! warning
This section is under construction.
# Pick your worker
!!! warning
This section is under construction.
# Secrets
Secrets are text payloads shared securely between the Arkindex instance and any worker. It is generally used to store sensitive values that may give Arkindex users access to any resources that should be private, for example because they cost money or are proprietary.
For more information about secrets, please visit [the Arkindex documentation](https://doc.arkindex.org/secrets/).
# Arkindex execution
!!! warning
This section is under construction.
# Ship your worker
!!! warning
This section is under construction.
......@@ -2,7 +2,7 @@
## Publication process
While workers may be [run locally](./run-local.md), they are usually written to launch on an Arkindex instance. A worker version on Arkindex is basically a configuration and a URL towards a Docker image, used at runtime during processes. The worker [template](./template-structure.md) includes an automatic publication process towards any Arkindex instance.
While workers may be [run locally](../implem/run/local.md), they are usually written to launch on an Arkindex instance. A worker version on Arkindex is basically a configuration and a URL towards a Docker image, used at runtime during processes. The worker [template](../init/template-structure.md) includes an automatic publication process towards any Arkindex instance.
## How it works
......
# Arkindex model version
!!! warning
This section is under construction.
# Use artifacts
!!! warning
This section is under construction.
# Base worker
!!! warning
This section is under construction.
# Dataset worker
!!! warning
This section is under construction.
# Element worker
!!! warning
This section is under construction.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment