Add our current architecture to the blog (#1483)

* Add our current architecture to the blog

* Update docs/blog/2023-02-11-architecture.md

Co-authored-by: Andrew Maguire <andrewm4894@gmail.com>

---------

Co-authored-by: Andrew Maguire <andrewm4894@gmail.com>

.github/workflows/deploy-docs-site.yaml

@@ -28,21 +28,28 @@ jobs:
       - name: Setup Node
         uses: actions/setup-node@v3
         with:
-          node-version: "16"
+          node-version: "18"
 
-      - name: Get yarn cache
-        id: yarn-cache
-        run: echo "YARN_CACHE_DIR=$(yarn cache dir)" >> "${GITHUB_OUTPUT}"
+      - name: Setup yarn
+        run:
+          corepack enable && corepack prepare yarn@stable --activate && mkdir
+          ~/.yarn
 
-      - name: Cache dependencies
+      - id: yarn-cache-dir-path
+        name: Get yarn cache directory path
+        run: echo "dir=$(yarn config get cacheFolder)" >> $GITHUB_OUTPUT
+        working-directory: docs
+
+      - name: Restore yarn cache
         uses: actions/cache@v3
         with:
-          path: ${{ steps.yarn-cache.outputs.YARN_CACHE_DIR }}
-          key: ${{ runner.os }}-docs-${{ hashFiles('**/yarn.lock') }}
+          path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
+          key:
+            yarn-cache-folder-${{ hashFiles('docs/yarn.lock', '.yarnrc.yml') }}
           restore-keys: |
-            ${{ runner.os }}-docs-
+            yarn-cache-folder-
 
-      - run: yarn install --frozen-lockfile
+      - run: yarn install --immutable
       - run: yarn build
 
       - name: Deploy

docs/.gitignore

@@ -1,5 +1,6 @@
 # Dependencies
 node_modules
+/.yarn
 
 # Production
 build

docs/.yarnrc.yml

@@ -0,0 +1 @@
+nodeLinker: node-modules

docs/blog/2023-02-11-architecture.md

@@ -0,0 +1,61 @@
+---
+title: The Architecture so Far!
+description: This is the architecture of our app so far.
+slug: 2023-02-11-architecture
+authors: AbdBarho
+tags: [open-assistant]
+---
+
+I thought it would make sense to document our architecture as a blog post, since
+it would be easily visible for everyone, and it would also be nice to look back
+a couple months from now and see how stuff has changed :)
+
+A lot of work was done in the past couple of week to establish the needed
+infrastructure both for data collection and inference purposes. Thanks to
+everyone, and especially community members who supported us so far!
+
+Our current plan for the architecture of the Open Assistant is as follows:
+
+```mermaid
+flowchart TD
+  subgraph next[Web Frontend]
+    direction TB
+    website([Browser]) & nextbackend[Backend] & webpostgres[(PostgreSQL)]
+  end
+
+  subgraph data[Python backend]
+    direction TB
+    backend[Backend] & postgres[(PostgreSQL)] & redis[(Redis)]
+  end
+
+  subgraph inference[Inference Service]
+    direction TB
+    inferenceServer[Server] -.- infpostgres[(PostgreSQL)]
+  end
+
+  subgraph workers[Inference Workers]
+    direction TB
+    worker1[Worker] --- textgen1[Text\ngenerator]
+    worker2[Worker] --- textgen2[Text\ngenerator]
+    worker3[Worker] --- textgen3[Text\ngenerator]
+  end
+
+  website --> nextbackend
+  nextbackend -.- webpostgres
+
+  next --- data
+
+  backend -.- postgres & redis
+
+  next --- inference
+
+  inference --- workers
+```
+
+We are working on setting up the inference as shown above, and considering our
+options for hosting, also, we want to move our authentication from the website
+to the python backend.
+
+Of course, this is by no means final, and lot of questions are still open, and
+that is the fun of it! If you want to join us on our journey, just give our
+[github](https://github.com/LAION-AI/Open-Assistant) a look!

docs/blog/authors.yml

@@ -3,3 +3,7 @@ yk:
   title: Project Lead
   url: https://www.ykilcher.com/
   image_url: https://www.ykilcher.com/_next/image?url=%2F_next%2Fstatic%2Fmedia%2Fheadshot.ff3a7ee3.webp&w=3840&q=75
+AbdBarho:
+  name: Abdullah Barhoum
+  title: Semi-professional Döner Enjoyer
+  image_url: https://avatars.githubusercontent.com/u/24505302?v=4

docs/docusaurus.config.js

@@ -29,6 +29,10 @@ const config = {
     defaultLocale: "en",
     locales: ["en"],
   },
+  markdown: {
+    mermaid: true,
+  },
+  themes: ["@docusaurus/theme-mermaid"],
 
   presets: [
     [

docs/package.json

@@ -15,8 +15,9 @@
     "typecheck": "tsc"
   },
   "dependencies": {
-    "@docusaurus/core": "^2.3.1",
-    "@docusaurus/preset-classic": "^2.3.1",
+    "@docusaurus/core": "2.3.1",
+    "@docusaurus/preset-classic": "2.3.1",
+    "@docusaurus/theme-mermaid": "2.3.1",
     "@mdx-js/react": "^1.6.22",
     "clsx": "^1.2.1",
     "docusaurus-preset-openapi": "^0.6.3",
@@ -27,7 +28,7 @@
     "url": "^0.11.0"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "^2.3.1",
+    "@docusaurus/module-type-aliases": "2.3.1",
     "@tsconfig/docusaurus": "^1.0.5",
     "typescript": "^4.7.4"
   },