Merge pull request #10 from samzong/master

upgrade docusaurus to v3

README.md

@@ -1,7 +1,7 @@
 # HAMi Docs & Website
 
-This repo contains the source code of [HAMi website](http://Karmada.io/) and all of the docs for HAMi.
-It's built by [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
+This repo contains the source code of [HAMi website](https://project-hami.io/) and all of the docs for HAMi.
+It's built by [Docusaurus 3](https://docusaurus.io/), a modern static website generator.
 
 Welcome to join us and you are more than appreciated to contribute!
 

docs/contributor/contribute-docs.md

@@ -4,7 +4,7 @@ title: How to contribute docs
 
 Starting from version 1.3, the community documentation will be available on the Karmada website.
 This document explains how to contribute docs to
-the `karmada-io/website` repository.
+the `Project-HAMi/website` repository.
 
 ## Prerequisites
 
@@ -21,7 +21,7 @@ the `karmada-io/website` repository.
 You can set up your local environment by cloning our website repository.
 
 ```shell
-git clone https://github.com/karmada-io/website.git
+git clone https://github.com/Project-HAMi/website.git
 cd website
 ```
 
@@ -111,7 +111,7 @@ Creating a sidebar is useful to:
 * Display a sidebar on each of those documents
 * Provide paginated navigation, with next/previous button
 
-For our docs, you can know how our documents are organized from <https://github.com/karmada-io/website/blob/main/sidebars.js>.
+For our docs, you can know how our documents are organized from [https://github.com/Project-HAMi/website/blob/main/sidebars.js](https://github.com/Project-HAMi/website/blob/main/sidebars.js).
 
 ```
 module.exports = {
@@ -157,14 +157,14 @@ If you add a document, you must add it to `sidebars.js` to make it display prope
 ### About Chinese docs
 
 There are two situations about the Chinese version of the document:
-* You want to translate our existing English docs to Chinese. In this case, you need to modify the corresponding file content from <https://github.com/karmada-io/website/tree/main/i18n/zh/docusaurus-plugin-content-docs/current>. 
+* You want to translate our existing English docs to Chinese. In this case, you need to modify the corresponding file content from [https://github.com/Project-HAMi/website/tree/main/i18n/zh/docusaurus-plugin-content-docs/current](https://github.com/Project-HAMi/website/tree/main/i18n/zh/docusaurus-plugin-content-docs/current). 
   The organization of this directory is exactly the same as the outer layer. `current.json` holds translations for the documentation directory. You can edit it if you want to translate the name of directory.
 * You want to contribute Chinese docs without English version. Any articles of any kind are welcomed. In this case, you can add articles and titles to the main directory first. Article content can be TBD first, like this. 
   Then add the corresponding Chinese content to the Chinese directory.
 
 ## Debugging docs
 
-Now you have already completed docs. After you start a PR to `karmada.io/website`, if you have passed CI, you can get a preview of your document on the website.
+Now you have already completed docs. After you start a PR to `Project-HAMi/website`, if you have passed CI, you can get a preview of your document on the website.
 
 Click **Details** marked in red, and you will enter the preview view of the website.
 

docs/get-started/nginx-example.md

@@ -23,7 +23,7 @@ Execute the following steps on all your GPU nodes.
 
 This README assumes pre-installation of NVIDIA drivers and the `nvidia-container-toolkit`. Additionally, it assumes configuration of the `nvidia-container-runtime` as the default low-level runtime.
 
-Please see: <https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/install-guide.html>
+Please see: [https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/install-guide.html](https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/install-guide.html)
 
 #### Example for debian-based systems with `Docker` and `containerd`
 

docs/installation/prequisities.md

@@ -15,7 +15,7 @@ Execute the following steps on all your GPU nodes.
 
 This README assumes pre-installation of NVIDIA drivers and the `nvidia-container-toolkit`. Additionally, it assumes configuration of the `nvidia-container-runtime` as the default low-level runtime.
 
-Please see: <https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/install-guide.html>
+Please see: [https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/install-guide.html](https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/install-guide.html)
 
 ### Example for debian-based systems with `Docker` and `containerd`
 

docs/releases.md

@@ -4,7 +4,7 @@ title:  Releases
 
 ## Release Notes and Assets
 
-Release notes are available on GitHub at https://github.com/karmada-io/karmada/releases.
+Release notes are available on GitHub at https://github.com/Project-HAMi/HAMi/releases.
 
 ## Release Management
 
@@ -61,7 +61,7 @@ Release branches and PRs are managed as follows:
 
 A minor release will contain a mix of features, enhancements, and bug fixes.
 
-Major features follow the Karmada Design Proposal process. You can refer to [here](https://github.com/karmada-io/karmada/tree/master/docs/proposals/resource-interpreter-webhook) as a proposal example.
+Major features follow the Karmada Design Proposal process. You can refer to [here](https://github.com/Project-HAMi/HAMi/tree/master/docs/proposals/resource-interpreter-webhook) as a proposal example.
 
 During the start of a release, there may be many issues assigned to the release milestone. The priorities for the release are discussed in the bi-weekly community meetings. 
 As the release progresses several issues may be moved to the next milestone. Hence, if an issue is important it is important to advocate its priority early in the release cycle.
@@ -75,7 +75,7 @@ For example, [here](https://hub.docker.com/r/karmada/karmada-controller-manager)
 Since v1.2.0, the following artifacts are uploaded:
 
 * crds.tar.gz
-* karmada-chart-v<version_number>.tgz
+* karmada-chart-v\<version_number\>.tgz
 * karmadactl-darwin-amd64.tgz
 * karmadactl-darwin-amd64.tgz.sha256
 * karmadactl-darwin-arm64.tgz
@@ -95,10 +95,10 @@ Since v1.2.0, the following artifacts are uploaded:
 * Source code(zip)
 * Source code(tar.gz)
 
-You can visit `https://github.com/karmada-io/karmada/releases/download/v<version_number>/<artifact_name>` to download the artifacts above.
+You can visit `https://github.com/Project-HAMi/HAMi/releases/download/v<version_number>/<artifact_name>` to download the artifacts above.
 
 For example:
 
 ```shell
-wget https://github.com/karmada-io/karmada/releases/download/v1.3.0/karmadactl-darwin-amd64.tgz
+wget https://github.com/Project-HAMi/HAMi/releases/download/v1.3.0/karmadactl-darwin-amd64.tgz
 ```

docs/userguide/monitoring/real-time-usage.md

@@ -0,0 +1,5 @@
+---
+title: Real-time usage
+---
+
+To be improved.

docusaurus.config.js

@@ -1,8 +1,12 @@
+const {themes} = require('prism-react-renderer');
+const lightTheme = themes.github;
+const darkTheme = themes.dracula;
+
 /** @type {import('@docusaurus/types').DocusaurusConfig} */
 module.exports = {
   title: "HAMi",
   tagline: "Open, Device Virtualization, VGPU, Heterogeneous AI Computing",
-  url: "https://karmada.io",
+  url: "https://project-hami.io",
   baseUrl: "/",
   onBrokenLinks: "throw",
   onBrokenMarkdownLinks: "throw",
@@ -170,7 +174,7 @@ module.exports = {
       `,
     },
     prism: {
-      theme: require("prism-react-renderer/themes/dracula"),
+      additionalLanguages: ['bash', 'diff', 'json'],
     },
   },
   presets: [
@@ -180,7 +184,7 @@ module.exports = {
         docs: {
           sidebarPath: require.resolve("./sidebars.js"),
           editUrl: function ({ locale, docPath }) {
-            return `https://github.com/karmada-io/website/edit/main/docs/${docPath}`;
+            return `https://github.com/Project-HAMi/website/edit/main/docs/${docPath}`;
           },
           showLastUpdateAuthor: true,
           showLastUpdateTime: true,
@@ -192,7 +196,7 @@ module.exports = {
         },
         blog: {
           showReadingTime: true,
-          editUrl: "https://github.com/karmada-io/website/tree/main/",
+          editUrl: "https://github.com/Project-HAMi/website/tree/main/",
         },
         theme: {
           customCss: require.resolve("./src/css/custom.css"),

netlify.toml

@@ -1,2 +1,2 @@
 [build.environment]
-    NODE_VERSION = "16"
+    NODE_VERSION = "18"