Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions .github/workflows/build.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
name: Build for GitHub Pages

on: push

permissions:
contents: write

jobs:
build:
name: Build for GitHub Pages
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/setup-node@v2
with:
node-version: 18.x
cache: yarn
cache-dependency-path: yarn.lock
- name: Build website
run: |
yarn install --frozen-lockfile
yarn build
2 changes: 1 addition & 1 deletion docs/design/services/next/kluster.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Kubernetes, Hadooop).

## Design

Kluster is designed to be a stateless gateway that interfaces with the [Dask-Gateway](https://gateway.dask.org/en/latest/)
Kluster is designed to be a stateless gateway that interfaces with the [Dask-Gateway](https://gateway.dask.org/)
and only provide a more documentated GraphQL API inline with the Arkitekt design principles. Additionally to the main
Kluster Server we also provide a modified Dask-Gateway [Kluster-Gateway] that comes with a JWT Authentication plugin
so that Arkitekts Authentication paradigm can be used to authenticate users to the Dask-Gateway, when not using the
Expand Down
2 changes: 1 addition & 1 deletion docs/design/terminology/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ sidebar_position: 1

While developing Arkitekt, we have found ourselves in the position of having to explain the same concepts over and over again. And while we are happy to do that, we also want to make sure that we are not wasting your time. So we decided to create a list of terms that we use in Arkitekt, and explain them in a way that we hope is easy to understand. If you are new to Arkitekt, we recommend that you take a look at this list before you start reading the rest of the documentation, as they will help you understand the rest of the documentation better, and guide you in the right direction.

If you feel like we have missed something, or if you have a suggestion for a better explanation, please let us know by creating an issue on our [Github repository](https://github.com/arkitekt/arkitektio.github.io/doks) (or just edit the file and create a pull request).
If you feel like we have missed something, or if you have a suggestion for a better explanation, please let us know by creating an issue on our [Github repository](https://github.com/arkitektio/arkitektio.github.io) (or just edit the file and create a pull request).

## Before we start

Expand Down
8 changes: 1 addition & 7 deletions docs/design/terminology/manifest.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -99,8 +99,7 @@ available in the `alpha` channel.

:::


# Scopes
## Scopes

Scopes are a way of describing the access rights that your app requires. When a user authenticates
your app, they will be asked to grant your app access to certain resources, such as their image data
Expand All @@ -115,8 +114,3 @@ of new apps. We will gradually introduce scope based access control, and we will
for existing apps.

:::

```yaml



4 changes: 2 additions & 2 deletions docs/developers/contribute/projects.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -80,9 +80,9 @@ are managed with poetry.

- [rekuest](https://github.com/arkitektio/rekuest): A Python client for the Rekuest service, with convenience methods for quickly creating and running nodes
- [mikro](https://github.com/arkitektio/mikro): A Python client for the Mikro service, with convenience methods to interact with your data through common python abstractions (numpy, pandas, xarray, ...)
- [fluss](https://github.com/jhnnarkitektiosrs/fluss): A Python client for Fluss service, to retrieve and alter workflows
- [fluss](https://github.com/arkitektio/fluss-server): A Python client for Fluss service, to retrieve and alter workflows
- [unlok](https://github.com/arkitektio/unlok): A Python client for the Lok service, to interact with users, write comments, and manage permissions
- [port](https://github.com/arkitektio/port): A Python client for Fluss service, with convenience methods to create and run plugins
- [port](https://github.com/arkitektio/port-server): A Python client for Fluss service, with convenience methods to create and run plugins
- [reaktion](https://github.com/arkitektio/reaktion): A Scheduler for Fluss workflows, that can execute locally or use arkitekt to to run nodes remotely

#### Supporting libraries
Expand Down
6 changes: 3 additions & 3 deletions docs/introduction/first_steps/brief_interlude.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,9 @@ to much interactive help about it.
You did it 🥰! We are connected
</div>

</HerreGuard>
</FaktsGuard>

### What that means for you

Well now that we are connected, we can actually install repositories and workflows directly from this website. So lets do that before we start with the next chapter.
Expand Down Expand Up @@ -104,6 +107,3 @@ But most importantly, we love it because everyone can do that. You can create yo
this documentatoin. Its not that complicated.

:::

</HerreGuard>
</FaktsGuard>
4 changes: 2 additions & 2 deletions docs/showcases/paper/streaming_workflow.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ OME compliant format.

#### [Gucker](https://github.com/arkitektio-apps/gucker)

This workflow uses the Gucker App to watch a directory for new files opn the Acquisition Computer. To install Gucker, download the latest release from the [Gucker Releases](https://github.com/jhnnsrs/arkitektio-apps/releases/latest).
This workflow uses the Gucker App to watch a directory for new files opn the Acquisition Computer. To install Gucker, download the latest release from the [Gucker Releases](https://github.com/arkitektio-apps/gucker/releases/latest).
You can also choose to install Gucker from source by following the instructions on the [Gucker Github](https://github.com/arkitektio-apps/gucker).

#### [Mikro-Napari](https://github.com/arkitektio-apps/mikro-napari) and [Napari](https://napari.org/)
Expand Down Expand Up @@ -105,7 +105,7 @@ TODO: Video
in the "Choose Directory" field. Additionally as Gucker also acts as a Data Exporter, you need to specify an "Export Directory". This should not be the same as the "Import Directory", but can be any other directory
on your computer with write access.

3. Connect and Login with the Arkitekt instance (if your Arkitekt instance does not show up, make sure you are [advertising](/docs/introduction/installation#advertisting) it)
3. Connect and Login with the Arkitekt instance (if your Arkitekt instance does not show up, make sure you are [advertising](/docs/introduction/installation#advertising) it)

### Optional: Parallel Processing Computers

Expand Down
4 changes: 2 additions & 2 deletions docs/troubleshooting/startup.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Step Zero: The basics
Step One: Konstruktor

- [Konstruktor claimed it couldn't find docker](#konstruktor-couldnt-find-docker)
- [I coudn't install the "Paper" channel deployment](#couldn't-install-from-paper-channel)
- [I coudn't install the "Paper" channel deployment](#couldnt-install-from-paper-channel)
- [Konstruktor claimed it couldn't find my GPU](#konstruktor-couldnt-find-my-gpu)
- [Konstruktor showed me an error message](#konstruktor-showed-me-an-error-message)

Expand Down Expand Up @@ -163,7 +163,7 @@ If you are certain however that you have a GPU installed, and you want to use GP

If you get an error message, you cannot access your GPU. If you get a list of information about your GPU, you can access your GPU :).

6. If Konstruktor claims to have not found your GPU, but you are certain that you have a compatible GPU installed, and you have the latest drivers installed, please open an Issue on our [GitHub](https://github.com/jhnnsrs/arkitektio/issues)
6. If Konstruktor claims to have not found your GPU, but you are certain that you have a compatible GPU installed, and you have the latest drivers installed, please open an Issue on our [GitHub](https://github.com/arkitektio/arkitekt/issues)

#### Konstruktor showed me an error message

Expand Down
4 changes: 2 additions & 2 deletions docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,8 @@ const config = {
baseUrl: "/", 

trailingSlash: false,
onBrokenLinks: "warn",
onBrokenMarkdownLinks: "warn",
onBrokenLinks: "throw",
onBrokenMarkdownLinks: "throw",
favicon: "img/favicon.svg",
markdown: {
mermaid: true,
Expand Down