From dedb0e415e2d40dfab84b3439a25f30aed16dfe2 Mon Sep 17 00:00:00 2001 From: Mikey O'Toole Date: Wed, 1 Nov 2023 08:44:59 +0000 Subject: [PATCH 1/8] add troubleshooting steps to migration/upgrade page --- website/docs/migration/index.mdx | 36 ++++++++++++++++++++++++++++++-- 1 file changed, 34 insertions(+), 2 deletions(-) diff --git a/website/docs/migration/index.mdx b/website/docs/migration/index.mdx index c78662f032eb..fd6c804438a9 100644 --- a/website/docs/migration/index.mdx +++ b/website/docs/migration/index.mdx @@ -1,6 +1,7 @@ --- slug: /migration --- +import DocCardList from '@theme/DocCardList'; # Upgrading Docusaurus @@ -8,6 +9,37 @@ Docusaurus versioning is based on the `major.minor.patch` scheme and respects [* **Breaking changes** are only released on major version upgrades, and thoroughly documented in the following upgrade guides. -import DocCardList from '@theme/DocCardList'; - + +## Troubleshooting Upgrades + +When upgrading Docusaurus you may experience issues caused by mismatching cached dependencies - there are a few troubleshooting steps you should perform to resolve these common issues before reporting a bug or seeking support. + +### Run the `clear` command + +This CLI command is used to clear a Docusaurus site's generated assets, caches and build artifacts. + +```bash npm2yarn +npm run clear +``` + +### Remove `node_modules` and your `lock` file(s). + +Remove the `node_modules` folder and your package manager's `lock` file using the following: + + + +```bash +rm -rf node_modules yarn.lock package-lock.json +``` + + Date: Wed, 1 Nov 2023 08:52:44 +0000 Subject: [PATCH 2/8] Close TabItem and Tabs --- website/docs/migration/index.mdx | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/website/docs/migration/index.mdx b/website/docs/migration/index.mdx index fd6c804438a9..c5b6bbe7edce 100644 --- a/website/docs/migration/index.mdx +++ b/website/docs/migration/index.mdx @@ -1,7 +1,7 @@ --- slug: /migration --- -import DocCardList from '@theme/DocCardList'; + # Upgrading Docusaurus @@ -9,6 +9,8 @@ Docusaurus versioning is based on the `major.minor.patch` scheme and respects [* **Breaking changes** are only released on major version upgrades, and thoroughly documented in the following upgrade guides. +import DocCardList from '@theme/DocCardList'; + ## Troubleshooting Upgrades @@ -37,6 +39,8 @@ rm -rf node_modules yarn.lock package-lock.json ```powershell @('node_modules','yarn.lock','package-lock.json') | Remove-Item -Force -Recurse -ErrorAction SilentlyContinue ``` + + Then reinstall packages and regenerate the `lock` file using: From 30a3b8b67515d59d1236d2aa571ca7f10186bbfd Mon Sep 17 00:00:00 2001 From: Mikey O'Toole Date: Wed, 1 Nov 2023 08:59:48 +0000 Subject: [PATCH 3/8] Close second TabItem --- website/docs/migration/index.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/migration/index.mdx b/website/docs/migration/index.mdx index c5b6bbe7edce..805e27d41e9e 100644 --- a/website/docs/migration/index.mdx +++ b/website/docs/migration/index.mdx @@ -35,7 +35,7 @@ Remove the `node_modules` folder and your package manager's `lock` file using th rm -rf node_modules yarn.lock package-lock.json ``` - ```powershell @('node_modules','yarn.lock','package-lock.json') | Remove-Item -Force -Recurse -ErrorAction SilentlyContinue ``` From 334686d5149483947046bbab6df55d7994acd695 Mon Sep 17 00:00:00 2001 From: Mikey O'Toole Date: Wed, 1 Nov 2023 09:09:34 +0000 Subject: [PATCH 4/8] add PowerShell to languages --- website/docusaurus.config.ts | 1 + 1 file changed, 1 insertion(+) diff --git a/website/docusaurus.config.ts b/website/docusaurus.config.ts index b3dca14db3ba..f3e1bc26f462 100644 --- a/website/docusaurus.config.ts +++ b/website/docusaurus.config.ts @@ -486,6 +486,7 @@ export default async function createConfigAsync() { 'haskell', 'matlab', 'PHp', + 'powershell', 'bash', 'diff', 'json', From e30f600ed0b4677cdcba593d1b4d52af1a85bc21 Mon Sep 17 00:00:00 2001 From: Joshua Chen Date: Wed, 1 Nov 2023 11:47:23 -0400 Subject: [PATCH 5/8] Update index.mdx --- website/docs/migration/index.mdx | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/website/docs/migration/index.mdx b/website/docs/migration/index.mdx index 805e27d41e9e..a1efcb54f04e 100644 --- a/website/docs/migration/index.mdx +++ b/website/docs/migration/index.mdx @@ -2,7 +2,6 @@ slug: /migration --- - # Upgrading Docusaurus Docusaurus versioning is based on the `major.minor.patch` scheme and respects [**Semantic Versioning**](https://semver.org/). @@ -13,7 +12,7 @@ import DocCardList from '@theme/DocCardList'; -## Troubleshooting Upgrades +## Troubleshooting upgrades When upgrading Docusaurus you may experience issues caused by mismatching cached dependencies - there are a few troubleshooting steps you should perform to resolve these common issues before reporting a bug or seeking support. @@ -25,20 +24,24 @@ This CLI command is used to clear a Docusaurus site's generated assets, caches a npm run clear ``` -### Remove `node_modules` and your `lock` file(s). +### Remove `node_modules` and your lock file(s) -Remove the `node_modules` folder and your package manager's `lock` file using the following: +Remove the `node_modules` folder and your package manager's lock file using the following: + ```bash rm -rf node_modules yarn.lock package-lock.json ``` + + ```powershell @('node_modules','yarn.lock','package-lock.json') | Remove-Item -Force -Recurse -ErrorAction SilentlyContinue ``` + From d53dfe363bee5df6d0fa53e8df75ab7a678eff56 Mon Sep 17 00:00:00 2001 From: sebastienlorber Date: Fri, 1 Dec 2023 17:47:14 +0100 Subject: [PATCH 6/8] prettier --- website/docs/migration/index.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/migration/index.mdx b/website/docs/migration/index.mdx index a1efcb54f04e..9a9a5616edac 100644 --- a/website/docs/migration/index.mdx +++ b/website/docs/migration/index.mdx @@ -18,7 +18,7 @@ When upgrading Docusaurus you may experience issues caused by mismatching cached ### Run the `clear` command -This CLI command is used to clear a Docusaurus site's generated assets, caches and build artifacts. +This CLI command is used to clear a Docusaurus site's generated assets, caches and build artifacts. ```bash npm2yarn npm run clear From 271efb330ab2385c2887fe6ad2e348ac865a86c1 Mon Sep 17 00:00:00 2001 From: sebastienlorber Date: Fri, 1 Dec 2023 20:11:32 +0100 Subject: [PATCH 7/8] test commit --- website/docusaurus.config.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docusaurus.config.ts b/website/docusaurus.config.ts index f3e1bc26f462..a3ec228b9861 100644 --- a/website/docusaurus.config.ts +++ b/website/docusaurus.config.ts @@ -5,7 +5,7 @@ * LICENSE file in the root directory of this source tree. */ import path from 'path'; - +// blablablitest import npm2yarn from '@docusaurus/remark-plugin-npm2yarn'; import remarkMath from 'remark-math'; import rehypeKatex from 'rehype-katex'; From f0bccf61d0764bad2722c8f89f5a2c3bee50be65 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=A9bastien=20Lorber?= Date: Fri, 5 Apr 2024 15:11:51 +0200 Subject: [PATCH 8/8] Update website/docusaurus.config.ts --- website/docusaurus.config.ts | 1 - 1 file changed, 1 deletion(-) diff --git a/website/docusaurus.config.ts b/website/docusaurus.config.ts index a3ec228b9861..0bdf3aa7be1b 100644 --- a/website/docusaurus.config.ts +++ b/website/docusaurus.config.ts @@ -5,7 +5,6 @@ * LICENSE file in the root directory of this source tree. */ import path from 'path'; -// blablablitest import npm2yarn from '@docusaurus/remark-plugin-npm2yarn'; import remarkMath from 'remark-math'; import rehypeKatex from 'rehype-katex';