From ebf841b33e984a38436f3a95e9578d1173fef2ba Mon Sep 17 00:00:00 2001 From: Theodore Chu Date: Thu, 27 Feb 2020 13:27:32 -0800 Subject: [PATCH 1/4] Update installation.md Add information on how to update/upgrade the version of Docusaurus --- website/docs/installation.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/website/docs/installation.md b/website/docs/installation.md index a18c978070bf..8c8b4bcd3214 100644 --- a/website/docs/installation.md +++ b/website/docs/installation.md @@ -97,6 +97,26 @@ npm run build and contents will be generated within the `/build` directory, which can be copied to any static file hosting service like [GitHub pages](https://pages.github.com/), [Now](https://zeit.co/now) or [Netlify](https://www.netlify.com/). Check out the docs on [deployment](deployment.md) for more details. +## Updating Your Docusaurus Version +To update/upgrade your Docusaurus Version, manually change the version number in `package.json`. Here, the version number is `X`: +``` + "dependencies": { + "@docusaurus/core": "^2.0.0-alpha.X", + "@docusaurus/preset-classic": "^2.0.0-alpha.X", + ``` +Then, in the directory containing `package.json`, run: +``` +yarn install +``` +To check that that the update occurred successfully, run: +``` +yarn docusaurus --version +``` +If the update occurred successfully, then the output should be: +``` +2.0.0-alpha.X +``` + ## Problems? Ask for help on [Stack Overflow](https://stackoverflow.com/questions/tagged/docusaurus), on our [GitHub repository](https://github.com/facebook/docusaurus) or [Twitter](https://twitter.com/docusaurus). From a59dd8fc3646ee30a90ba98d3ddc0cb97e7d7099 Mon Sep 17 00:00:00 2001 From: Yangshun Tay Date: Fri, 28 Feb 2020 09:44:28 +0800 Subject: [PATCH 2/4] Update installation.md --- website/docs/installation.md | 37 ++++++++++++++++++++++++------------ 1 file changed, 25 insertions(+), 12 deletions(-) diff --git a/website/docs/installation.md b/website/docs/installation.md index 8c8b4bcd3214..57dc3b1c94ab 100644 --- a/website/docs/installation.md +++ b/website/docs/installation.md @@ -97,24 +97,37 @@ npm run build and contents will be generated within the `/build` directory, which can be copied to any static file hosting service like [GitHub pages](https://pages.github.com/), [Now](https://zeit.co/now) or [Netlify](https://www.netlify.com/). Check out the docs on [deployment](deployment.md) for more details. -## Updating Your Docusaurus Version -To update/upgrade your Docusaurus Version, manually change the version number in `package.json`. Here, the version number is `X`: -``` +## Update your Docusaurus version + +There are many ways to update your Docusaurus version. One guaranteed way is to manually change the version number in `package.json` to the desired version. Note that all `@docusaurus/`-namespaced packages should be using the same version. + +```json "dependencies": { - "@docusaurus/core": "^2.0.0-alpha.X", - "@docusaurus/preset-classic": "^2.0.0-alpha.X", - ``` -Then, in the directory containing `package.json`, run: + "@docusaurus/core": "^2.0.0-alpha.43", + "@docusaurus/preset-classic": "^2.0.0-alpha.43", + ... + } + ``` -yarn install + +Then, in the directory containing `package.json`, run your package manager's install command: + +```bash npm2yarn +npm install ``` + To check that that the update occurred successfully, run: + +```bash npm2yarn +npm docusaurus --version ``` -yarn docusaurus --version -``` -If the update occurred successfully, then the output should be: + +You should see the correct version as output. + +Alternatively, if you are using Yarn, you can do: + ``` -2.0.0-alpha.X +yarn upgrade @docusaurus/core@2.0.0-alpha.43 @docusaurus/preset-classic@2.0.0-alpha.43 ``` ## Problems? From c126a9eae994c43711c8f08786e841c98c605435 Mon Sep 17 00:00:00 2001 From: Yangshun Tay Date: Fri, 28 Feb 2020 09:44:52 +0800 Subject: [PATCH 3/4] Update installation.md --- website/docs/installation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/installation.md b/website/docs/installation.md index 57dc3b1c94ab..eab80a1c7133 100644 --- a/website/docs/installation.md +++ b/website/docs/installation.md @@ -97,7 +97,7 @@ npm run build and contents will be generated within the `/build` directory, which can be copied to any static file hosting service like [GitHub pages](https://pages.github.com/), [Now](https://zeit.co/now) or [Netlify](https://www.netlify.com/). Check out the docs on [deployment](deployment.md) for more details. -## Update your Docusaurus version +## Updating your Docusaurus version There are many ways to update your Docusaurus version. One guaranteed way is to manually change the version number in `package.json` to the desired version. Note that all `@docusaurus/`-namespaced packages should be using the same version. From acd93718b5a9f19b8c1177fa2533198c1ab000d7 Mon Sep 17 00:00:00 2001 From: Yangshun Tay Date: Fri, 28 Feb 2020 09:45:14 +0800 Subject: [PATCH 4/4] Update installation.md --- website/docs/installation.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/website/docs/installation.md b/website/docs/installation.md index eab80a1c7133..a98aa06a505c 100644 --- a/website/docs/installation.md +++ b/website/docs/installation.md @@ -106,8 +106,7 @@ There are many ways to update your Docusaurus version. One guaranteed way is to "@docusaurus/core": "^2.0.0-alpha.43", "@docusaurus/preset-classic": "^2.0.0-alpha.43", ... - } - + } ``` Then, in the directory containing `package.json`, run your package manager's install command: