From e155371e3c3a8659a719b62c462bb09e2302d8a9 Mon Sep 17 00:00:00 2001 From: FabrizioCafolla Date: Fri, 17 Nov 2023 14:45:41 +0100 Subject: [PATCH] feat: update docs --- .../{deploy_docs.yml => deploy-docs.yml} | 5 ++-- docs/docusaurus.config.js | 5 ++-- docs/package.json | 23 ++++++++++--------- docs/sidebars.js | 2 +- 4 files changed, 18 insertions(+), 17 deletions(-) rename .github/workflows/{deploy_docs.yml => deploy-docs.yml} (89%) diff --git a/.github/workflows/deploy_docs.yml b/.github/workflows/deploy-docs.yml similarity index 89% rename from .github/workflows/deploy_docs.yml rename to .github/workflows/deploy-docs.yml index 7793345..ce343c6 100644 --- a/.github/workflows/deploy_docs.yml +++ b/.github/workflows/deploy-docs.yml @@ -12,6 +12,7 @@ env: PROJECT_NAME: "neulabs-cdk-constructs" AWS_REGION: "eu-west-1" AWS_ROLE_NAME: 'github-oidc-workflow-role' + AWS_ACCOUNT_ID: "482061573712" # AWS DevOps account id permissions: id-token: write @@ -19,7 +20,7 @@ permissions: jobs: trigger-workflow: - runs-on: ubuntu-latest + runs-on: ubuntu-22.04 steps: - name: Git clone the repository uses: actions/checkout@v3 @@ -27,7 +28,7 @@ jobs: - name: Configure aws credentials uses: aws-actions/configure-aws-credentials@v2 with: - role-to-assume: arn:aws:iam::${{ secrets.AWS_ACCOUNT_ID }}:role/${{ env.AWS_ROLE_NAME }} + role-to-assume: arn:aws:iam::${{ env.AWS_ACCOUNT_ID }}:role/${{ env.AWS_ROLE_NAME }} aws-region: ${{ env.AWS_REGION }} mask-aws-account-id: no diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js index 88a3d24..c89ea4d 100644 --- a/docs/docusaurus.config.js +++ b/docs/docusaurus.config.js @@ -1,8 +1,7 @@ -// @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 index 70710b7..a13c3e1 100644 --- a/docs/package.json +++ b/docs/package.json @@ -1,6 +1,6 @@ { "name": "neulabs-docs", - "version": "2.0.0", + "version": "3.0.0", "private": true, "scripts": { "docusaurus": "docusaurus", @@ -15,19 +15,20 @@ "typecheck": "tsc" }, "dependencies": { - "@docusaurus/core": "2.4.3", - "@docusaurus/preset-classic": "2.4.3", - "@docusaurus/theme-mermaid": "^2.4.3", - "@mdx-js/react": "^1.6.22", + "@docusaurus/core": "3.0.0", + "@docusaurus/preset-classic": "3.0.0", + "@docusaurus/theme-mermaid": "^3.0.0", + "@mdx-js/react": "^3.0.0", "clsx": "^1.2.1", - "prism-react-renderer": "^1.3.5", - "react": "^17.0.2", - "react-dom": "^17.0.2" + "prism-react-renderer": "^2.2.0", + "react": "^18.2.0", + "react-dom": "^18.2.0" }, "devDependencies": { - "@docusaurus/module-type-aliases": "2.4.1", - "@tsconfig/docusaurus": "^1.0.5", - "typescript": "^4.7.4" + "@docusaurus/module-type-aliases": "3.0.0", + "@docusaurus/tsconfig": "3.0.0", + "@types/react": "^18.2.37", + "typescript": "~5.2.2" }, "browserslist": { "production": [ diff --git a/docs/sidebars.js b/docs/sidebars.js index c2116c1..0db57a1 100644 --- a/docs/sidebars.js +++ b/docs/sidebars.js @@ -1,6 +1,6 @@ /** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */ const sidebars = { - default: [ + menu: [ 'index', ] };