forked from beimingwu/beimingwu
perf(docs): replace with github link
This commit is contained in:
GeneLiuXe
parent
fa3e0d7b19
commit
ed2e012881
12
README.md
12
README.md
|
|
@ -84,15 +84,15 @@ The functionalities of the four layers are described as follows:
|
|||
### Project Structure
|
||||
|
||||
Based on the system architecture, Beimingwu is developed with five sub-projects:
|
||||
- [`Engine`](https://www.gitlink.org.cn/beimingwu/learnware): Encompassing core components and algorithms within the learnware paradigm, and providing a command-line client for user interaction, it has been releasead as the [learnware](https://pypi.org/project/learnware/) package.
|
||||
- [`Frontend`](https://www.gitlink.org.cn/beimingwu/beimingwu/tree/main/frontend): Provide the interface and functionality for user interaction with the learnware dock system, including the main system and administrator system.
|
||||
- [`Backend`](https://www.gitlink.org.cn/beimingwu/beimingwu/tree/main/backend): Responsible for handling the dock system's operation logic and data operations, it ensures system stability and high performance.
|
||||
- [`Docs`](https://www.gitlink.org.cn/beimingwu/beimingwu/tree/main/docs): Maintain system documentation, including user guides, development guides, etc., ensuring system usability.
|
||||
- [`Deploy`](https://www.gitlink.org.cn/beimingwu/beimingwu/tree/main/deploy): Manage the system deployment configuration, including frontend and backend deployment files.
|
||||
- [`Engine`](https://github.com/Learnware-LAMDA/Learnware): Encompassing core components and algorithms within the learnware paradigm, and providing a command-line client for user interaction, it has been releasead as the [learnware](https://pypi.org/project/learnware/) package.
|
||||
- [`Frontend`](https://github.com/Learnware-LAMDA/Beimingwu/tree/main/frontend): Provide the interface and functionality for user interaction with the learnware dock system, including the main system and administrator system.
|
||||
- [`Backend`](https://github.com/Learnware-LAMDA/Beimingwu/tree/main/backend): Responsible for handling the dock system's operation logic and data operations, it ensures system stability and high performance.
|
||||
- [`Docs`](https://github.com/Learnware-LAMDA/Beimingwu/tree/main/docs): Maintain system documentation, including user guides, development guides, etc., ensuring system usability.
|
||||
- [`Deploy`](https://github.com/Learnware-LAMDA/Beimingwu/tree/main/deploy): Manage the system deployment configuration, including frontend and backend deployment files.
|
||||
|
||||
# Quick Start
|
||||
|
||||
Welcome to experience [Beimingwu](https://bmwu.cloud/). The following instructions will assist you in quickly exploring the search functionality on the system website and provide two demo cases from learnware search to learnware deployment using the [learnware](https://www.gitlink.org.cn/beimingwu/learnware) package.
|
||||
Welcome to experience [Beimingwu](https://bmwu.cloud/). The following instructions will assist you in quickly exploring the search functionality on the system website and provide two demo cases from learnware search to learnware deployment using the [learnware](https://github.com/Learnware-LAMDA/Learnware) package.
|
||||
|
||||
The installation instructions for the learnware package can be found here: [Installation Guide](docs/content/en/overview/installation.md).
|
||||
|
||||
|
|
|
|||
12
README_zh.md
12
README_zh.md
|
|
@ -85,15 +85,15 @@
|
|||
### 项目结构
|
||||
|
||||
基于上述系统架构，北冥坞项目一共包含如下五个子项目：
|
||||
- [`系统引擎`](https://www.gitlink.org.cn/beimingwu/learnware)：实现了学件范式中的核心组件和算法，并提供了一个基于命令行的客户端以便于用户交互，同时将其作为 [learnware](https://pypi.org/project/learnware/) 包发布。
|
||||
- [`系统前端`](https://www.gitlink.org.cn/beimingwu/beimingwu/tree/main/frontend)：提供了用户与系统交互的界面和功能，包括主系统和管理员系统。
|
||||
- [`系统后端`](https://www.gitlink.org.cn/beimingwu/beimingwu/tree/main/backend)：负责处理系统的运行逻辑和数据操作，确保系统的稳定性和高性能。
|
||||
- [`系统文档`](https://www.gitlink.org.cn/beimingwu/beimingwu/tree/main/docs)：维护系统的文档，包括用户指南、开发指南等，确保系统的易用性。
|
||||
- [`系统部署`](https://www.gitlink.org.cn/beimingwu/beimingwu/tree/main/deploy)：负责管理系统的部署配置，包括前后端的部署文件。
|
||||
- [`系统引擎`](https://github.com/Learnware-LAMDA/Learnware)：实现了学件范式中的核心组件和算法，并提供了一个基于命令行的客户端以便于用户交互，同时将其作为 [learnware](https://pypi.org/project/learnware/) 包发布。
|
||||
- [`系统前端`](https://github.com/Learnware-LAMDA/Beimingwu/tree/main/frontend)：提供了用户与系统交互的界面和功能，包括主系统和管理员系统。
|
||||
- [`系统后端`](https://github.com/Learnware-LAMDA/Beimingwu/tree/main/backend)：负责处理系统的运行逻辑和数据操作，确保系统的稳定性和高性能。
|
||||
- [`系统文档`](https://github.com/Learnware-LAMDA/Beimingwu/tree/main/docs)：维护系统的文档，包括用户指南、开发指南等，确保系统的易用性。
|
||||
- [`系统部署`](https://github.com/Learnware-LAMDA/Beimingwu/tree/main/deploy)：负责管理系统的部署配置，包括前后端的部署文件。
|
||||
|
||||
# 快速上手
|
||||
|
||||
欢迎体验[北冥坞系统](https://bmwu.cloud/)！下述内容将帮你快速探索系统网站上的学件查搜功能，并基于 [learnware](https://www.gitlink.org.cn/beimingwu/learnware) 包提供两个从学件查搜至学件部署的应用案例。
|
||||
欢迎体验[北冥坞系统](https://bmwu.cloud/)！下述内容将帮你快速探索系统网站上的学件查搜功能，并基于 [learnware](https://github.com/Learnware-LAMDA/Learnware) 包提供两个从学件查搜至学件部署的应用案例。
|
||||
|
||||
learnware 包的安装可参考：[环境安装](docs/content/zh-CN/overview/installation.md)。
|
||||
|
||||
|
|
|
|||
|
|
@ -15,7 +15,7 @@ mkdir -p Beimingwu/deploy/
|
|||
cp -r ../../backend Beimingwu/
|
||||
cp -r ../../frontend Beimingwu/
|
||||
cp -r ../static Beimingwu/deploy/
|
||||
git clone https://gitlink.org.cn/beimingwu/learnware.git
|
||||
git clone https://github.com/Learnware-LAMDA/Learnware.git
|
||||
```
|
||||
|
||||
## Build Image
|
||||
|
|
|
|||
|
|
@ -48,7 +48,7 @@ kubectl create -f https://raw.githubusercontent.com/spotahome/redis-operator/${R
|
|||
## Deploy Backend
|
||||
### Download Deployment Files
|
||||
```shell
|
||||
git clone https://gitlink.org.cn/beimingwu/beimingwu.git
|
||||
git clone https://github.com/Learnware-LAMDA/Beimingwu.git
|
||||
cd Beimingwu/deploy/kubernetes
|
||||
```
|
||||
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ Visit the [Docker official website](https://docs.docker.com/compose/install/#ins
|
|||
|
||||
## Deploy Using Docker Compose
|
||||
|
||||
Download the [backend code](https://www.gitlink.org.cn/beimingwu/beimingwu) and navigate to the `deploy/docker_compose` directory.
|
||||
Download the [backend code](https://github.com/Learnware-LAMDA/Beimingwu/tree/main) and navigate to the `deploy/docker_compose` directory.
|
||||
|
||||
## Prepare Files
|
||||
Prepare miniconda installation file
|
||||
|
|
@ -19,7 +19,7 @@ mkdir -p Beimingwu/deploy/
|
|||
cp -r ../../backend Beimingwu/
|
||||
cp -r ../../frontend Beimingwu/
|
||||
cp -r ../static Beimingwu/deploy/
|
||||
git clone https://gitlink.org.cn/beimingwu/learnware.git
|
||||
git clone https://github.com/Learnware-LAMDA/Learnware.git
|
||||
```
|
||||
|
||||
## Build Image
|
||||
|
|
|
|||
|
|
@ -7,9 +7,9 @@ Beimingwu learnware dock system is developed with five sub-projects:
|
|||
- **Docs**: Maintain system documentation, including user guides, development guides, etc., ensuring system usability.
|
||||
- **Deploy**: Manage the system deployment configuration, including frontend and backend deployment files.
|
||||
|
||||
The `Engine` is implemented in a separate `Learnware` [code repository](https://www.gitlink.org.cn/beimingwu/learnware) and is configured with its own [project documentation](https://learnware.readthedocs.io/en/latest/).
|
||||
The `Engine` is implemented in a separate `Learnware` [code repository](https://github.com/Learnware-LAMDA/Learnware) and is configured with its own [project documentation](https://learnware.readthedocs.io/en/latest/).
|
||||
|
||||
The remaining four sub-projects are implemented within the `Beimingwu` [code repository](https://www.gitlink.org.cn/beimingwu/beimingwu) and are managed using a `Monorepo` approach. The following sections will provide details on the specific structure and development guidelines for the `Beimingwu` code repository.
|
||||
The remaining four sub-projects are implemented within the `Beimingwu` [code repository](https://github.com/Learnware-LAMDA/Beimingwu) and are managed using a `Monorepo` approach. The following sections will provide details on the specific structure and development guidelines for the `Beimingwu` code repository.
|
||||
|
||||
## Beimingwu Project Structure
|
||||
|
||||
|
|
|
|||
|
|
@ -16,9 +16,9 @@ pip install learnware==0.3.2 -i https://pypi.tuna.tsinghua.edu.cn/simple
|
|||
|
||||
## Install from Source Code
|
||||
|
||||
The source code of the `learnware` package is available on the [GitLink](https://www.gitlink.org.cn/beimingwu/learnware) platform, and users can download the source code for installation using the following code:
|
||||
The source code for the `learnware` package is concurrently released on both [GitLink](https://www.gitlink.org.cn/beimingwu/learnware) and [Github](https://github.com/Learnware-LAMDA/Learnware) platforms. Taking GitHub as an example, users can install it through the source code in the following manner:
|
||||
```bash
|
||||
git clone https://gitlink.org.cn/beimingwu/learnware.git
|
||||
git clone https://github.com/Learnware-LAMDA/Learnware.git
|
||||
cd Learnware
|
||||
git fetch origin main
|
||||
git checkout main
|
||||
|
|
|
|||
|
|
@ -43,7 +43,7 @@ kubectl create -f https://raw.githubusercontent.com/spotahome/redis-operator/${R
|
|||
## 部署后端
|
||||
### 下载部署文件
|
||||
```shell
|
||||
git clone https://gitlink.org.cn/beimingwu/beimingwu.git
|
||||
git clone https://github.com/Learnware-LAMDA/Beimingwu.git
|
||||
cd Beimingwu/deploy/kubernetes
|
||||
```
|
||||
### 设置配置文件
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@
|
|||
|
||||
## 使用 Docker Compose 部署
|
||||
|
||||
下载 [后端代码](https://www.gitlink.org.cn/beimingwu/beimingwu)，进入 `deploy/docker_compose` 目录。
|
||||
下载 [后端代码](https://github.com/Learnware-LAMDA/Beimingwu)，进入 `deploy/docker_compose` 目录。
|
||||
|
||||
### 准备文件
|
||||
miniconda 安装文件
|
||||
|
|
@ -18,7 +18,7 @@ mkdir -p Beimingwu/deploy/
|
|||
cp -r ../../backend Beimingwu/
|
||||
cp -r ../../frontend Beimingwu/
|
||||
cp -r ../static Beimingwu/deploy/
|
||||
git clone https://gitlink.org.cn/beimingwu/learnware.git
|
||||
git clone https://github.com/Learnware-LAMDA/Learnware.git
|
||||
```
|
||||
|
||||
### 构建镜像
|
||||
|
|
|
|||
|
|
@ -7,9 +7,9 @@
|
|||
- **系统文档**：维护系统的文档，包括用户指南、开发指南等，确保系统的易用性。
|
||||
- **系统部署**：负责管理系统的部署配置，包括前后端的部署文件。
|
||||
|
||||
其中「系统引擎」实现于独立的 `Learnware` [代码仓库](https://www.gitlink.org.cn/beimingwu/learnware)中，并配置了独立的[项目文档](https://learnware.readthedocs.io/en/latest/)。
|
||||
其中「系统引擎」实现于独立的 `Learnware` [代码仓库](https://github.com/Learnware-LAMDA/Learnware)中，并配置了独立的[项目文档](https://learnware.readthedocs.io/en/latest/)。
|
||||
|
||||
其余四个子项目则实现于 `Beimingwu` [代码仓库](https://www.gitlink.org.cn/beimingwu/beimingwu)中，并采用 `Monorepo` 的方式进行管理。下文将介绍 `Beimingwu` 代码仓库的具体结构与开发规范。
|
||||
其余四个子项目则实现于 `Beimingwu` [代码仓库](https://github.com/Learnware-LAMDA/Beimingwu)中，并采用 `Monorepo` 的方式进行管理。下文将介绍 `Beimingwu` 代码仓库的具体结构与开发规范。
|
||||
|
||||
## Beimingwu 项目结构
|
||||
|
||||
|
|
|
|||
|
|
@ -16,9 +16,9 @@ pip install learnware==0.3.2 -i https://pypi.tuna.tsinghua.edu.cn/simple
|
|||
|
||||
## 通过源码安装
|
||||
|
||||
`learnware` 包的源代码发布在 [GitLink](https://www.gitlink.org.cn/beimingwu/learnware) 平台上，用户可按下述方式通过源代码进行安装：
|
||||
`learnware` 包的源代码同时发布在 [GitLink](https://www.gitlink.org.cn/beimingwu/learnware) 和 [Github](https://github.com/Learnware-LAMDA/Learnware) 平台上。以 Github 平台为例，用户可按下述方式通过源代码安装：
|
||||
```bash
|
||||
git clone https://gitlink.org.cn/beimingwu/learnware.git
|
||||
git clone https://github.com/Learnware-LAMDA/Learnware.git
|
||||
cd Learnware
|
||||
git fetch origin main
|
||||
git checkout main
|
||||
|
|
|
|||
Loading…
Reference in New Issue