From 4bf769205abb3d82cea99bd9fb88a9da2e58001c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Alexander=20Schr=C3=B6ter?= Date: Tue, 5 Mar 2024 13:17:36 +0100 Subject: [PATCH 1/6] set to throw on broken links --- docusaurus.config.js | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docusaurus.config.js b/docusaurus.config.js index 73bc2e47..0124946e 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -37,8 +37,8 @@ const config = { baseUrl: "/",  trailingSlash: false, - onBrokenLinks: "warn", - onBrokenMarkdownLinks: "warn", + onBrokenLinks: "throw", + onBrokenMarkdownLinks: "throw", favicon: "img/favicon.svg", markdown: { mermaid: true, From c6e59ca76214f00e6986a549c84b88b873da67a1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Alexander=20Schr=C3=B6ter?= Date: Tue, 5 Mar 2024 13:24:46 +0100 Subject: [PATCH 2/6] add build check on push --- .github/workflows/build.yaml | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 .github/workflows/build.yaml diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml new file mode 100644 index 00000000..44db4a92 --- /dev/null +++ b/.github/workflows/build.yaml @@ -0,0 +1,22 @@ +name: Build for GitHub Pages + +on: push + +permissions: + contents: write + +jobs: + deploy: + 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 From 0c6c4928333cfe783633fa1fe80d0ee6ea42ba2b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Alexander=20Schr=C3=B6ter?= Date: Tue, 5 Mar 2024 13:54:30 +0100 Subject: [PATCH 3/6] fix broken anchors --- docs/showcases/paper/streaming_workflow.mdx | 2 +- docs/troubleshooting/startup.mdx | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/showcases/paper/streaming_workflow.mdx b/docs/showcases/paper/streaming_workflow.mdx index a1e35606..ff1e424a 100644 --- a/docs/showcases/paper/streaming_workflow.mdx +++ b/docs/showcases/paper/streaming_workflow.mdx @@ -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 diff --git a/docs/troubleshooting/startup.mdx b/docs/troubleshooting/startup.mdx index 3c1e0cf1..b0c86db3 100644 --- a/docs/troubleshooting/startup.mdx +++ b/docs/troubleshooting/startup.mdx @@ -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) From 32f50f58efa2bc5f6ab4b6bbde41aa18fa2874ea Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Alexander=20Schr=C3=B6ter?= Date: Tue, 5 Mar 2024 15:41:39 +0100 Subject: [PATCH 4/6] more fixes --- .github/workflows/build.yaml | 2 +- docs/design/terminology/manifest.mdx | 6 ------ docs/introduction/first_steps/brief_interlude.mdx | 6 +++--- 3 files changed, 4 insertions(+), 10 deletions(-) diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml index 44db4a92..1a7beb48 100644 --- a/.github/workflows/build.yaml +++ b/.github/workflows/build.yaml @@ -6,7 +6,7 @@ permissions: contents: write jobs: - deploy: + build: name: Build for GitHub Pages runs-on: ubuntu-latest steps: diff --git a/docs/design/terminology/manifest.mdx b/docs/design/terminology/manifest.mdx index e9181ad0..2c3fbde4 100644 --- a/docs/design/terminology/manifest.mdx +++ b/docs/design/terminology/manifest.mdx @@ -99,7 +99,6 @@ available in the `alpha` channel. ::: - # Scopes Scopes are a way of describing the access rights that your app requires. When a user authenticates @@ -115,8 +114,3 @@ of new apps. We will gradually introduce scope based access control, and we will for existing apps. ::: - -```yaml - - - diff --git a/docs/introduction/first_steps/brief_interlude.mdx b/docs/introduction/first_steps/brief_interlude.mdx index 5206cf20..57bcf3f6 100644 --- a/docs/introduction/first_steps/brief_interlude.mdx +++ b/docs/introduction/first_steps/brief_interlude.mdx @@ -70,6 +70,9 @@ to much interactive help about it. You did it 🥰! We are connected + + + ### 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. @@ -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. ::: - - - From fae0ce7cabba66cf27ca1eb0de7f4032c5272d3a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Alexander=20Schr=C3=B6ter?= Date: Tue, 5 Mar 2024 18:04:55 +0100 Subject: [PATCH 5/6] fixed multiple external dead links --- docs/design/services/next/kluster.mdx | 2 +- docs/design/terminology/index.md | 2 +- docs/developers/contribute/projects.mdx | 4 ++-- docs/showcases/paper/streaming_workflow.mdx | 2 +- docs/troubleshooting/startup.mdx | 2 +- 5 files changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/design/services/next/kluster.mdx b/docs/design/services/next/kluster.mdx index 8bc26f65..59187056 100644 --- a/docs/design/services/next/kluster.mdx +++ b/docs/design/services/next/kluster.mdx @@ -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 diff --git a/docs/design/terminology/index.md b/docs/design/terminology/index.md index ef426caa..bfa93047 100644 --- a/docs/design/terminology/index.md +++ b/docs/design/terminology/index.md @@ -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 diff --git a/docs/developers/contribute/projects.mdx b/docs/developers/contribute/projects.mdx index dc3abb12..f484d190 100644 --- a/docs/developers/contribute/projects.mdx +++ b/docs/developers/contribute/projects.mdx @@ -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 diff --git a/docs/showcases/paper/streaming_workflow.mdx b/docs/showcases/paper/streaming_workflow.mdx index ff1e424a..dc29b9d8 100644 --- a/docs/showcases/paper/streaming_workflow.mdx +++ b/docs/showcases/paper/streaming_workflow.mdx @@ -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/) diff --git a/docs/troubleshooting/startup.mdx b/docs/troubleshooting/startup.mdx index b0c86db3..d3b11b02 100644 --- a/docs/troubleshooting/startup.mdx +++ b/docs/troubleshooting/startup.mdx @@ -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 From f8bac1e81380c05a98d02f7f25dace446a88bf5c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Alexander=20Schr=C3=B6ter?= Date: Tue, 5 Mar 2024 18:24:09 +0100 Subject: [PATCH 6/6] fix broken anchor --- docs/design/terminology/manifest.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/design/terminology/manifest.mdx b/docs/design/terminology/manifest.mdx index 2c3fbde4..a354bcc5 100644 --- a/docs/design/terminology/manifest.mdx +++ b/docs/design/terminology/manifest.mdx @@ -99,7 +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