docs: update projects documentation for v2.8

.github/workflows/beta_pull_request.yml

@@ -40,12 +40,12 @@ jobs:
           DOTENV_CONFIG_PATH: .env.beta
         run: yarn ycai build
 
-      - name: Deploy YCAI Dashboard
-        uses: burnett01/[email protected]
-        with:
-          switches: -avzr --delete
-          path: ./YCAI/build/dashboard/
-          remote_path: ~/beta-studio/
-          remote_host: ${{ secrets.YCAI_BETA_DEPLOY_HOST }}
-          remote_user: ${{ secrets.YCAI_DEPLOY_USER }}
-          remote_key: ${{ secrets.YCAI_DEPLOY_KEY }}
+      # - name: Deploy YCAI Dashboard
+      #   uses: burnett01/[email protected]
+      #   with:
+      #     switches: -avzr --delete
+      #     path: ./YCAI/build/dashboard/
+      #     remote_path: ~/beta-studio/
+      #     remote_host: ${{ secrets.YCAI_BETA_DEPLOY_HOST }}
+      #     remote_user: ${{ secrets.YCAI_DEPLOY_USER }}
+      #     remote_key: ${{ secrets.YCAI_DEPLOY_KEY }}

.github/workflows/build_from_zip.yml

@@ -0,0 +1,47 @@
+name: TrEx - Build from ZIP
+
+on:
+  push:
+    branches:
+      - daily
+      - fix/*
+      - feat/*
+
+jobs:
+  release:
+    name: Release
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: [16.x]
+    services:
+      mongo-db:
+        image: mongo:4.2
+        ports:
+          - 27017:27017
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v2
+        with:
+          node-version: ${{ matrix.node-version }}
+          cache: 'yarn'
+          cache-dependency-path: yarn.lock
+
+      - name: Install dependencies
+        run: yarn
+
+      - name: Build ZIP for Firefox
+        run: ./scripts/shrink.sh
+
+      - name: Log in to registry
+        # This is where you will update the personal access token to GITHUB_TOKEN
+        run: echo "${{ secrets.GITHUB_TOKEN }}" | docker login ghcr.io -u $ --password-stdin
+
+      - name: Test ZIP with docker
+        run: |
+          docker build -f from-zip.Dockerfile -t build-from-zip .

.github/workflows/daily_release.yml

@@ -47,12 +47,12 @@ jobs:
       - name: Release Version
         run: yarn release-it --no-github.release --release-version
 
-      - name: Deploy YCAI Dashboard
-        uses: burnett01/[email protected]
-        with:
-          switches: -avzr --delete
-          path: ./platforms/ycai/studio/build/dashboard/
-          remote_path: ~/staging-studio/
-          remote_host: ${{ secrets.YCAI_DAILY_DEPLOY_HOST }}
-          remote_user: ${{ secrets.YCAI_DEPLOY_USER }}
-          remote_key: ${{ secrets.YCAI_DEPLOY_KEY }}
+      # - name: Deploy YCAI Dashboard
+      #   uses: burnett01/[email protected]
+      #   with:
+      #     switches: -avzr --delete
+      #     path: ./platforms/ycai/studio/build/dashboard/
+      #     remote_path: ~/staging-studio/
+      #     remote_host: ${{ secrets.YCAI_DAILY_DEPLOY_HOST }}
+      #     remote_user: ${{ secrets.YCAI_DEPLOY_USER }}
+      #     remote_key: ${{ secrets.YCAI_DEPLOY_KEY }}

.github/workflows/docs_pull_request.yml

@@ -1,18 +1,17 @@
-name: TRex - Release "daily"
+name: TRex - Docs
 
 on:
   push:
     branches:
       - daily
       - docs/**
+      - feat/**
       - fix/**
       - refactor/**
     paths:
     - "docs/**"
-    - "platforms/guardoni/docs/**"
-    - "platforms/tktrex/docs/**"
-    - "platforms/yttrex/docs/**"
-    - "platforms/ycai/docs/**"
+    - "packages/**"
+    - "platforms/**"
 
 jobs:
   release:
@@ -38,9 +37,6 @@ jobs:
       - name: Install dependencies
         run: yarn
 
-      # - name: Test project
-      #   run: yarn test
-
       - name: Build Docs
         env:
           DEBUG: "@trex*,@YCAI*"

.github/workflows/master_release.yml

@@ -155,17 +155,17 @@ jobs:
           git config --global user.name "Team - Tracking Exposed"
           yarn release-it --ci
 
-      - name: Build Dashboard
-        env:
-          DOTENV_CONFIG_PATH: .env
-        run: yarn ycai build
-
-      - name: Deploy YCAI Dashboard
-        uses: burnett01/[email protected]
-        with:
-          switches: -avzr --delete
-          path: ./platforms/ycai/studio/build/dashboard/
-          remote_path: ~/studio-website/
-          remote_host: ${{ secrets.YCAI_DEPLOY_HOST }}
-          remote_user: ${{ secrets.YCAI_DEPLOY_USER }}
-          remote_key: ${{ secrets.YCAI_DEPLOY_KEY }}
+      # - name: Build Dashboard
+      #   env:
+      #     DOTENV_CONFIG_PATH: .env
+      #   run: yarn ycai build
+
+      # - name: Deploy YCAI Dashboard
+      #   uses: burnett01/[email protected]
+      #   with:
+      #     switches: -avzr --delete
+      #     path: ./platforms/ycai/studio/build/dashboard/
+      #     remote_path: ~/studio-website/
+      #     remote_host: ${{ secrets.YCAI_DEPLOY_HOST }}
+      #     remote_user: ${{ secrets.YCAI_DEPLOY_USER }}
+      #     remote_key: ${{ secrets.YCAI_DEPLOY_KEY }}

.gitignore

@@ -24,3 +24,6 @@ coverage
 
 # let everyone use their own workspace config
 *.code-workspace
+
+# auto generated docs
+typedoc

docker-compose.yml

@@ -59,6 +59,7 @@ services:
       dockerfile: from-zip.Dockerfile
       context: .
       target: unzip
+    entrypoint: /bin/sh
     container_name: build-from-zip
     stdin_open: true # docker run -i
     tty: true # docker run -t

docs/docs/partials/extension/_development.mdx

@@ -6,14 +6,7 @@ import CodeBlock from '@theme/CodeBlock';
 
 
 ### Prerequisites
-
-<ul>
-  <li>
-    <a href="backend">
-      @{props.platformPrefix}trex/backend
-    </a>{" "}up and running
-  </li>
-</ul>
+* <a href="backend">@{props.platformPrefix}trex/backend</a> up and running
 
 ### Run "watch" mode
 
@@ -23,4 +16,7 @@ To start developing the extension you need to compile the source code with `webp
   yarn {props.platformPrefix}:ext watch
 </CodeBlock>
 
-<p>then, you can open your browser's development panel and load the extension from the output folder <i>{props.platformPrefix}</i>.</p>
+### Load the extension
+
+In your browser's development panel or in your extension manager, load the extension from the <i>{props.platformPrefix}</i> output folder. To do that, you will need to navigate to `platforms/yttrex/extension/build` and load the extension from that folder.
+