Skip to content
Snippets Groups Projects
Commit 1abda0a7 authored by Bastien Abadie's avatar Bastien Abadie
Browse files

Merge branch 'update-refs' into 'master'

Update gitlab links to use teklia namespace

See merge request teklia/arkindex/doc!74
parents 82a92f43 54bc8649
No related branches found
No related tags found
1 merge request!74Update gitlab links to use teklia namespace
Pipeline #13842 passed
......@@ -583,7 +583,7 @@ An example of a to-do comment with a GitLab issue follows:
```markdown
<!--
TODO: Update screenshots for v1.0
https://gitlab.com/arkindex/doc/issues/99999
https://gitlab.com/teklia/arkindex/doc/issues/99999
-->
```
......
......@@ -149,7 +149,7 @@ When clicking on the **Retry** button or creating a new process with similar wor
If some elements are locked in a `started` state and could never complete, you will have to wait a 1 hour timeout to start processing them again with this worker.
{% warning() %}
[Base worker package](https://gitlab.com/arkindex/base-worker/) must be at version `0.2.2` or above for a worker to skip processed elements.
[Base worker package](https://gitlab.com/teklia/workers/base-worker/) must be at version `0.2.2` or above for a worker to skip processed elements.
{% end %}
It is also possible to list all existing activities at a project's level. This page is accessible from the main page of a project by clicking on **Action** > **Workers activity**.
......
......@@ -25,7 +25,7 @@ These complex tools are easily launched from your web browser, and run on powerf
{{ figure(image="overview/process.png", height=240, caption="Easily view the progress of Machine Learning workflows") }}
<!-- TODO: Add link on how to create a process: https://gitlab.com/arkindex/doc/-/issues/8 -->
<!-- TODO: Add link on how to create a process: https://gitlab.com/teklia/arkindex/doc/-/issues/8 -->
## Data Import
......@@ -36,9 +36,9 @@ Arkindex can import your data from different sources:
- an [Amazon S3](https://aws.amazon.com/s3/) bucket
- [Transkribus](https://readcoop.eu/transkribus) collections
<!-- TODO: Add link on how to import from transkribus: https://gitlab.com/arkindex/doc/-/issues/23 -->
<!-- TODO: Add link on how to import from transkribus: https://gitlab.com/teklia/arkindex/doc/-/issues/23 -->
<!-- TODO: Add link on how to create a process: https://gitlab.com/arkindex/doc/-/issues/7 -->
<!-- TODO: Add link on how to create a process: https://gitlab.com/teklia/arkindex/doc/-/issues/7 -->
## Customizable user access
......
......@@ -16,7 +16,7 @@ We have open-sourced two API clients in Python to ease the usage of our platform
### Python API client
A low-level API client in Python is available on PyPI as [arkindex-client](https://pypi.org/project/arkindex-client/). Its source code is freely available on [this repository](https://gitlab.com/arkindex/api-client/).
A low-level API client in Python is available on PyPI as [arkindex-client](https://pypi.org/project/arkindex-client/). Its source code is freely available on [this repository](https://gitlab.com/teklia/arkindex/api-client/).
You can install it on your computer (provided you have Python 3.6+ installed) using pip:
......@@ -41,7 +41,7 @@ More documentation is available on the [official package page](https://pypi.org/
### Command line tool
A more high-level tool is available using the command line. It implements common operations to be more efficient with Arkindex.
It is available on PyPI as [arkindex-cli](https://pypi.org/project/arkindex-cli/). Its source code is freely available on [this repository](https://gitlab.com/arkindex/cli/).
It is available on PyPI as [arkindex-cli](https://pypi.org/project/arkindex-cli/). Its source code is freely available on [this repository](https://gitlab.com/teklia/arkindex/cli/).
A dedicated detailed documentation is available at [cli.arkindex.org](https://cli.arkindex.org/).
......
......@@ -14,14 +14,14 @@ This section consists of the following guides:
* [Setting up a new worker](@/workers/create.md)
<!--
TODO: * [Worker implementation guidelines](@/workers/implement.md)
https://gitlab.com/arkindex/doc/-/issues/17
https://gitlab.com/teklia/arkindex/doc/-/issues/17
-->
* [Running your worker locally](@/workers/run-local.md)
<!--
TODO: * [Running your worker on Arkindex](@/workers/run-arkindex.md)
https://gitlab.com/arkindex/doc/-/issues/18
https://gitlab.com/teklia/arkindex/doc/-/issues/18
TODO: * [Writing tests for your worker](@/workers/tests.md)
https://gitlab.com/arkindex/doc/-/issues/16
https://gitlab.com/teklia/arkindex/doc/-/issues/16
-->
* [Maintaining a worker](@/workers/maintenance.md)
......
......@@ -64,7 +64,7 @@ and find bugs before they make their way into production.
<!-- TODO:
For more information, see [Writing unit tests for your worker](@/workers/tests.md).
https://gitlab.com/arkindex/doc/-/issues/16
https://gitlab.com/teklia/arkindex/doc/-/issues/16
-->
## Building
......
......@@ -68,7 +68,7 @@ To bootstrap a new Arkindex worker, some Python dependencies will be required:
* [tox][tox] will be used to run unit tests.
<!--
TODO: Link to [unit tests](@/workers/tests.md)
https://gitlab.com/arkindex/doc/-/issues/16
https://gitlab.com/teklia/arkindex/doc/-/issues/16
-->
* [cookiecutter][cookiecutter] will be used to bootstrap the project.
* [virtualenvwrapper][virtualenvwrapper] will be used to manage Python virtual
......@@ -126,7 +126,7 @@ to get a basic structure for your worker.
2. Enter this command and fill in the required information:
```
cookiecutter git@gitlab.com:arkindex/base-worker.git
cookiecutter git@gitlab.com:teklia/workers/base-worker.git
```
Cookiecutter will ask you for several options:
......@@ -219,10 +219,10 @@ to use a virtual environment.
<!--
TODO: You can now start [implementing your worker](@/workers/implement.md).
https://gitlab.com/arkindex/doc/-/issues/17
https://gitlab.com/teklia/arkindex/doc/-/issues/17
-->
[base-worker]: https://gitlab.com/arkindex/base-worker/
[base-worker]: https://gitlab.com/teklia/workers/base-worker/
[pre-commit]: https://pre-commit.com/
[tox]: https://tox.readthedocs.io/
[cookiecutter]: https://cookiecutter.readthedocs.io/
......
......@@ -28,4 +28,4 @@ any conflicts that may arise.
3. Using the Git diff, resolve the conflicts yourself as Cookiecutter will be
overwriting existing files.
[base-worker]: https://gitlab.com/arkindex/base-worker/
[base-worker]: https://gitlab.com/teklia/workers/base-worker/
......@@ -123,7 +123,7 @@ An example unit test file.
<!--
TODO: For more information, see [Writing tests for your worker](@/workers/tests.md).
https://gitlab.com/arkindex/doc/-/issues/16
https://gitlab.com/teklia/arkindex/doc/-/issues/16
-->
</dd>
......@@ -142,13 +142,13 @@ Arkindex elements.
<!-- TODO:
For more information, see
[Implementing a Machine Learning worker](@/workers/implement.md).
https://gitlab.com/arkindex/doc/-/issues/17
https://gitlab.com/teklia/arkindex/doc/-/issues/17
-->
</dd>
</dl>
[base-worker]: https://gitlab.com/arkindex/base-worker/
[base-worker]: https://gitlab.com/teklia/workers/base-worker/
[template-updates]: @/workers/maintenance.md#updating-the-template
[dockerignore]: https://docs.docker.com/engine/reference/builder/#dockerignore-file
[flake8]: https://flake8.pycqa.org/en/latest/user/configuration.html
......
......@@ -51,12 +51,12 @@ include:
<!--
TODO: Make the path relative to the YAML file itself, in the case of a
separate file for a single worker?
https://gitlab.com/arkindex/tasks/-/issues/95
https://gitlab.com/teklia/arkindex/tasks/-/issues/95
-->
<!--
TODO: Implement this!
https://gitlab.com/arkindex/tasks/-/issues/93
https://gitlab.com/teklia/arkindex/tasks/-/issues/93
`image`: Tag of an existing Docker image to use for this worker instead of building a
custom image from a Dockerfile.
......
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