✨ Add docs for namespace member api (#240)

go-sigma · Nov 24, 2023 · 13cf922 · 13cf922
1 parent 033b745
commit 13cf922
Show file tree

Hide file tree

Showing 24 changed files with 14,396 additions and 7,912 deletions.
diff --git a/.github/workflows/gh-pages.yml b/.github/workflows/gh-pages.yml
@@ -32,6 +32,7 @@ jobs:
         with:
           fetch-depth: 0
           lfs: true
+      - run: corepack enable
       - name: Setup node
         uses: actions/setup-node@v3
         with:
@@ -41,7 +42,7 @@ jobs:
       - name: Build website
         run: |
           cd docs
-          yarn install --frozen-lockfile
+          yarn install --immutable
           yarn build
       - name: Upload artifact
         uses: actions/upload-pages-artifact@v1

diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
@@ -37,7 +37,7 @@ jobs:
       - name: Build web
         run: |
           cd web
-          yarn install --frozen-lockfile
+          yarn install --immutable
           yarn build
       - name: Setup golangci-lint
         uses: golangci/golangci-lint-action@v3

diff --git a/.github/workflows/local-build.yml b/.github/workflows/local-build.yml
@@ -37,7 +37,7 @@ jobs:
       - name: Build server
         run: |
           cd web
-          yarn install --frozen-lockfile
+          yarn install --immutable
           yarn build
           cd ..
           make build
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -57,7 +57,7 @@ jobs:
       - name: Build web
         run: |
           cd web
-          yarn install --frozen-lockfile
+          yarn install --immutable
           yarn build
       - name: Setup minio
         run: |
@@ -138,7 +138,7 @@ jobs:
       - name: Build web
         run: |
           cd web
-          yarn install --frozen-lockfile
+          yarn install --immutable
           yarn build
       - name: Setup minio
         run: |
@@ -220,7 +220,7 @@ jobs:
       - name: Build web
         run: |
           cd web
-          yarn install --frozen-lockfile
+          yarn install --immutable
           yarn build
       - name: Setup minio
         run: |

diff --git a/.gitignore b/.gitignore
@@ -196,3 +196,4 @@ pkg/**/*.html
 
 *.tar.gz
 web/.yarn/
+docs/.yarn/
diff --git a/build/Dockerfile b/build/Dockerfile
@@ -10,7 +10,7 @@ COPY ./web /web
 
 WORKDIR /web
 
-RUN --mount=type=cache,target=/web/node_modules set -eux && corepack enable && yarn install --frozen-lockfile && yarn build
+RUN --mount=type=cache,target=/web/node_modules set -eux && corepack enable && yarn install --immutable && yarn build
 
 FROM alpine:${ALPINE_VERSION} as syft
 

diff --git a/build/Dockerfile.debian b/build/Dockerfile.debian
@@ -11,7 +11,7 @@ COPY ./web /web
 
 WORKDIR /web
 
-RUN --mount=type=cache,target=/web/node_modules set -eux && corepack enable && yarn install --frozen-lockfile && yarn build
+RUN --mount=type=cache,target=/web/node_modules set -eux && corepack enable && yarn install --immutable && yarn build
 
 FROM alpine:${ALPINE_VERSION} as syft
 

diff --git a/docs/.yarnrc.yml b/docs/.yarnrc.yml
@@ -0,0 +1 @@
+nodeLinker: node-modules
diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js
@@ -1,8 +1,8 @@
 // @ts-check
 // Note: type annotations allow type checking and IDEs autocompletion
 
-const lightCodeTheme = require('prism-react-renderer/themes/github');
-const darkCodeTheme = require('prism-react-renderer/themes/dracula');
+const lightCodeTheme = require('prism-react-renderer').themes.github;
+const darkCodeTheme = require('prism-react-renderer').themes.dracula;
 
 /** @type {import('@docusaurus/types').Config} */
 const config = {

diff --git a/docs/package.json b/docs/package.json
@@ -15,21 +15,20 @@
     "typecheck": "tsc"
   },
   "dependencies": {
-    "@docusaurus/core": "2.4.3",
-    "@docusaurus/preset-classic": "2.4.3",
-    "@mdx-js/react": "^1.6.22",
-    "clsx": "^1.2.1",
+    "@docusaurus/core": "3.0.0",
+    "@docusaurus/preset-classic": "3.0.0",
+    "@mdx-js/react": "^3.0.0",
     "docusaurus-plugin-sass": "^0.2.5",
-    "prism-react-renderer": "^1.3.5",
-    "react": "^17.0.2",
-    "react-dom": "^17.0.2",
-    "sass": "^1.69.3",
-    "typed.js": "^2.0.12"
+    "prism-react-renderer": "^2.3.0",
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0",
+    "sass": "^1.69.5",
+    "typed.js": "^2.1.0"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "2.4.3",
-    "@tsconfig/docusaurus": "^2.0.1",
-    "typescript": "^5.2.2"
+    "@docusaurus/module-type-aliases": "3.0.0",
+    "@tsconfig/docusaurus": "^2.0.2",
+    "typescript": "^5.3.2"
   },
   "browserslist": {
     "production": [
@@ -45,5 +44,6 @@
   },
   "engines": {
     "node": ">=16.14"
-  }
+  },
+  "packageManager": "yarn@4.0.2"
 }
diff --git a/docs/src/components/Hero/index.tsx b/docs/src/components/Hero/index.tsx
@@ -33,16 +33,12 @@ function Hero() {
                   />
                 </h2>
                 <Link
-                  className={clsx(
-                    'button button--outline button--secondary button--lg hero-started',
-                  )}
+                  className='button button--outline button--secondary button--lg hero-started'
                   to={useBaseUrl('docs/sigma')}>
                   Get started
                 </Link>
                 <Link
-                  className={clsx(
-                    'button button--outline button--secondary button--lg hero-try-demo',
-                  )}
+                  className='button button--outline button--secondary button--lg hero-try-demo'
                   to={"https://sigma.tosone.cn"}>
                   Try demo
                 </Link>
Original file line number	Diff line number	Diff line change
Expand Up		@@ -196,3 +196,4 @@ pkg/*/.html

		*.tar.gz
		web/.yarn/
		docs/.yarn/