Merge pull request #4 from frezes/gh-pages

inital website

Author: frezes

README.md

@@ -9,11 +9,22 @@ AI Labs for KubeSphere Extension.
 
 ## Quick Start
 
+### Option 1: Deploy with kubectl (Recommended)
+
+```sh
+kubectl apply -f https://raw.githubusercontent.com/frezes/ai-labs/refs/heads/main/deploy/deploy.yaml
+```
+
+### Option 2: Install as KubeSphere Extension (For Developers)
+
 ```sh
 git clone https://github.com/frezes/ai-labs.git
 cd ai-labs
 # publish the extension
 ksbuilder publish extensions/{extension}/config/{extension}
-# go to KubeSphere console and install the extension
 ```
 
+### Final Step (Required for both options)
+
+After deploying with either option, go to KubeSphere console and install the extension from the Extension Management page.
+

README_zh.md

@@ -0,0 +1,37 @@
+# AI-Labs
+
+KubeSphere 扩展的 AI 实验室。
+
+## 包含内容
+
+- [open-webui](./extensions/open-webui/README.md): 用户友好的 AI 界面（支持 Ollama、OpenAI API 等）
+- [jupyterhub](./extensions/jupyterhub/README.md): 多用户 Jupyter Notebook 服务器
+
+## 快速开始
+
+### 方式 1：使用 kubectl 部署（推荐）
+
+```sh
+kubectl apply -f https://raw.githubusercontent.com/frezes/ai-labs/refs/heads/main/deploy/deploy.yaml
+```
+
+### 方式 2：作为 KubeSphere 扩展安装（开发者使用）
+
+```sh
+git clone https://github.com/frezes/ai-labs.git
+cd ai-labs
+# 发布扩展
+ksbuilder publish extensions/{extension}/config/{extension}
+```
+
+### 最后步骤（两种方式都需要）
+
+使用任一方式部署后，请前往 KubeSphere 控制台，在扩展管理页面安装扩展。
+
+## 项目说明
+
+AI-Labs 是一个为 KubeSphere 平台设计的扩展集合，包含了多个与 AI 相关的工具和服务，可以帮助用户在 Kubernetes 环境中更好地利用 AI 技术。
+
+## 许可证
+
+本项目采用 Apache 2.0 许可证。详情请见 LICENSE 文件。

extensions/holmesgpt/README.md

@@ -0,0 +1,20 @@
+# Dependencies
+/node_modules
+
+# Production
+/build
+
+# Generated files
+.docusaurus
+.cache-loader
+
+# Misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*

website/.gitignore

@@ -0,0 +1,41 @@
+# Website
+
+This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
+
+## Installation
+
+```bash
+yarn
+```
+
+## Local Development
+
+```bash
+yarn start
+```
+
+This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
+
+## Build
+
+```bash
+yarn build
+```
+
+This command generates static content into the `build` directory and can be served using any static contents hosting service.
+
+## Deployment
+
+Using SSH:
+
+```bash
+USE_SSH=true yarn deploy
+```
+
+Not using SSH:
+
+```bash
+GIT_USER=<Your GitHub username> yarn deploy
+```
+
+If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.

website/README.md

@@ -0,0 +1,5 @@
+---
+sidebar_position: 5
+---
+
+# 变更日志

website/docs/changelog.md

@@ -0,0 +1,10 @@
+{
+  "label": "贡献",
+  "position": 4,
+  "link": {
+    "type": "generated-index",
+    "description": "本部分介绍如何为该项目做贡献。"
+  },
+  "collapsible": true,
+  "collapsed": false
+}

website/docs/contributing/Issues.md

@@ -0,0 +1,10 @@
+{
+  "label": "扩展组件管理",
+  "position": 3,
+  "link": {
+    "type": "generated-index",
+    "description": "本部分介绍如何在 KubeSphere 平台上管理扩展组件，包括安装、升级、配置和卸载等操作。"
+  },
+  "collapsible": true,
+  "collapsed": false
+}

website/docs/contributing/_category_.json

@@ -0,0 +1,63 @@
+---
+sidebar_position: 1
+title: 安装扩展组件
+---
+
+:::note
+有关扩展组件管理的更多信息，请参阅官方文档：[KubeSphere 扩展管理](https://docs.kubesphere.com.cn/v4.2.0/06-extension-management/)
+:::
+
+# 安装扩展组件
+
+本章节介绍如何在 **KubeSphere 扩展中心（Extension Center）** 中安装扩展组件。  
+有关扩展组件的访问、配置与使用方法，请参阅扩展组件使用指南。
+
+## 🛠 前提条件
+
+- 您必须在 KubeSphere 平台拥有 **platform-admin** 角色（平台管理员权限）。  
+  如需了解更多用户与角色相关信息，请参考 [用户和平台角色](https://docs.kubesphere.com.cn/v4.2.0/07-user-guide/02-platform-management/04-users-and-roles/)。
+
+## ⚙️ 安装步骤
+
+1. 使用具有 **platform-admin** 角色的账号登录 KubeSphere Web 控制台。  
+2. 进入 **扩展中心（Extension Center）**，搜索你要安装的扩展组件。  
+3. 点击扩展组件名称，然后点击 **安装（Install）**，进入组件安装页面。  
+4. 在 **版本选择** 页签中，选择扩展组件的版本号，并确认所有必装组件都已选中，点击 **下一步**。
+
+   > **说明**：  
+   > 在安装检测阶段，系统会识别该扩展组件是否依赖其他组件。  
+   > 这些依赖分为 **必装组件** 与 **选装组件**：  
+   > - 若某个必装组件状态显示 **未就绪**，则需要先安装该组件的正确版本，才能继续后续安装。  
+   > - 选装组件则不会阻止扩展组件的安装。
+
+5. 切换到 **扩展组件配置** 页签，在自定义配置输入框填入你所需的参数。检查 **最终配置** 后，点击 **下一步**。
+
+   > 小贴士：  
+   > - 点击右上角按钮可全屏查看配置内容  
+   > - 可上传自定义配置文件、下载当前配置或复制配置内容  
+
+6. 在 **扩展组件安装** 页签点击 **开始安装（Install）**，启动扩展组件安装流程。  
+7. 安装完成后，点击 **下一步**。  
+8. 在 **集群选择** 页签，选择目标集群（可以选择多个集群）以便在这些集群中启用该扩展组件。  
+9. 在 **差异化配置** 页签，可对不同集群的 Agent 配置进行个性化设置（如有必要），然后点击 **确定** 安装 Agent。等待安装完成即可。
+
+> ⚠️ 注意：  
+> 有些扩展组件不需要安装集群 Agent，即可能跳过 “集群选择” 与 “差异化配置” 页签，仅需按照页面提示完成安装。
+
+安装成功后，该扩展组件默认即被启用。
+
+---
+
+## 🧭 后续操作 & 使用
+
+- 在 KubeSphere 控制台的扩展中心中，查看已安装扩展列表  
+- 对已安装的扩展进行升级、配置或卸载  
+- 使用扩展组件提供的功能模块（访问 UI、管理 Agent、查看状态等）  
+
+---
+
+## 📘 延伸阅读
+
+- [管理扩展组件](/docs/extension-managerment/manage)
+- [升级扩展组件](/docs/extension-managerment/upgrade)
+- [卸载扩展组件](/docs/extension-managerment/uninstall)