Merge pull request #318 from Learnware-LAMDA/fix(docs)/readme

perf(docs): change url about website and repo
Learnware-LAMDA · Jan 14, 2024 · 139abcc · 139abcc
2 parents 8292f70 + 55addee
commit 139abcc
Show file tree

Hide file tree

Showing 9 changed files with 53 additions and 53 deletions.
diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml
@@ -27,4 +27,4 @@ body:
  attributes:
  label: Your contribution
  description: |
- Is there any way that you could help, e.g. by submitting a PR? Make sure to read the [developer guide](https://docs.beiming.cloud/en/developer-guide/structure-and-guidelines.html).
+ Is there any way that you could help, e.g. by submitting a PR? Make sure to read the [developer guide](https://docs.bmwu.cloud/en/developer-guide/structure-and-guidelines.html).
diff --git a/.github/ISSUE_TEMPLATE/question.yml b/.github/ISSUE_TEMPLATE/question.yml
@@ -9,4 +9,4 @@ body:
  attributes:
  label: Description
  description: |
- We sincerely suggest you to carefully read the [documentation](https://docs.beiming.cloud/en/overview/system-overview.html) of our project. After that, if you still feel puzzled, please describe the question clearly under this issue.
+ We sincerely suggest you to carefully read the [documentation](https://docs.bmwu.cloud/en/overview/system-overview.html) of our project. After that, if you still feel puzzled, please describe the question clearly under this issue.
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -6,7 +6,7 @@
 ## Pre-Submission Checklist
 <!--- Put an `x` in the boxes as follows. --->
 - [ ] This PR fixes a typo or improves the docs (you can dismiss the other checks if that's the case).
-- [ ] Have you followed the commit format and configured the hooks as outlined in the [development standards](https://docs.beiming.cloud/en/developer-guide/structure-and-guidelines.html#development-standards)?
+- [ ] Have you followed the commit format and configured the hooks as outlined in the [development standards](https://docs.bmwu.cloud/en/developer-guide/structure-and-guidelines.html#development-standards)?
 - [ ] Was this discussed/approved via a Github issue? Please provide a link
  to the issue.
 - [ ] If you modified the backend project, have you passed the relevant tests in `backend/tests`?

diff --git a/README.md b/README.md
@@ -5,34 +5,34 @@
 </div>
 
 <p align="center">
- <a href="https://github.com/Learnware-LAMDA/Beimingwu/blob/main/LICENSE">
-  <img alt="GitHub" src="https://img.shields.io/github/license/Learnware-LAMDA/Beimingwu?color=blue">
+ <a href="LICENSE">
+  <img alt="LICENSE" src="https://img.shields.io/pypi/l/learnware?color=blue">
  </a>
  <a href="https://bmwu.cloud/">
   <img alt="Website" src="https://img.shields.io/website/http/docs.bmwu.cloud?down_color=red&down_message=offline&up_message=online">
  </a>
- <a href="https://github.com/Learnware-LAMDA/Beimingwu/issues">
-  <img alt="Open issues" src="https://isitmaintained.com/badge/open/Learnware-LAMDA/Beimingwu.svg">
+ <a href="https://pypi.org/project/learnware/#history">
+  <img alt="PypI Versions" src="https://img.shields.io/pypi/v/learnware">
  </a>
- <a href="https://GitHub.com/Learnware-LAMDA/Beimingwu/pull/">
-  <img alt="GitHub pull-requests" src="https://img.shields.io/github/issues-pr/Learnware-LAMDA/Beimingwu.svg">
- </a>
- <a href="https://GitHub.com/Learnware-LAMDA/Beimingwu/commit/">
-  <img alt="GitHub latest commit" src="https://badgen.net/github/last-commit/Learnware-LAMDA/Beimingwu">
+ <a href="https://pypi.org/project/learnware/#files">
+  <img alt="Platform" src="https://img.shields.io/badge/platform-linux%20%7C%20windows%20%7C%20macos-lightgrey">
  </a>
  <a href="https://docs.bmwu.cloud/">
   <img alt="Docs Status" src="https://img.shields.io/website/http/docs.bmwu.cloud?down_color=red&down_message=failing&up_message=success&label=docs">
  </a>
+ <a href="https://img.shields.io/pypi/dm/example-package">
+  <img alt="PyPI Downloads" src="https://img.shields.io/pypi/dm/example-package">
+ </a>
 </p>
 
-<h3 align="center">
- <p>Beimingwu: The First Learnware Dock System</p>
- <p>A Systematic Implementation of Learnware Paradigm</p>
- <p>
+<p>
+ <h3 align="center">Beimingwu: The First Learnware Dock System</h3>
+ <h3 align="center">A Systematic Implementation of Learnware Paradigm</h3>
+ <h3 align="center">
   <b>English</b> |
-  <a href="https://github.com/Learnware-LAMDA/Beimingwu/blob/main/README_zh.md">中文</a>
- </p>
-</h3>
+  <a href="README_zh.md">中文</a>
+ </h3>
+</p>
 
 # Introduction
 
@@ -82,15 +82,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://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.
+- [`Engine`](https://gitee.com/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://gitee.com/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://gitee.com/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://gitee.com/beimingwu/beimingwu/tree/main/docs): Maintain system documentation, including user guides, development guides, etc., ensuring system usability.
+- [`Deploy`](https://gitee.com/beimingwu/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://github.com/Learnware-LAMDA/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://gitee.com/beimingwu/learnware) package.
 
 The installation instructions for the learnware package can be found here: [Installation Guide](docs/content/en/overview/installation.md).
 

diff --git a/README_zh.md b/README_zh.md
@@ -5,34 +5,34 @@
 </div>
 
 <p align="center">
- <a href="https://github.com/Learnware-LAMDA/Beimingwu/blob/main/LICENSE">
-  <img alt="GitHub" src="https://img.shields.io/github/license/Learnware-LAMDA/Beimingwu?color=blue">
+ <a href="LICENSE">
+  <img alt="LICENSE" src="https://img.shields.io/pypi/l/learnware?color=blue">
  </a>
  <a href="https://bmwu.cloud/">
   <img alt="Website" src="https://img.shields.io/website/http/docs.bmwu.cloud?down_color=red&down_message=offline&up_message=online">
  </a>
- <a href="https://github.com/Learnware-LAMDA/Beimingwu/issues">
-  <img alt="Open issues" src="https://isitmaintained.com/badge/open/Learnware-LAMDA/Beimingwu.svg">
+ <a href="https://pypi.org/project/learnware/#history">
+  <img alt="PypI Versions" src="https://img.shields.io/pypi/v/learnware">
  </a>
- <a href="https://GitHub.com/Learnware-LAMDA/Beimingwu/pull/">
-  <img alt="GitHub pull-requests" src="https://img.shields.io/github/issues-pr/Learnware-LAMDA/Beimingwu.svg">
- </a>
- <a href="https://GitHub.com/Learnware-LAMDA/Beimingwu/commit/">
-  <img alt="GitHub latest commit" src="https://badgen.net/github/last-commit/Learnware-LAMDA/Beimingwu">
+ <a href="https://pypi.org/project/learnware/#files">
+  <img alt="Platform" src="https://img.shields.io/badge/platform-linux%20%7C%20windows%20%7C%20macos-lightgrey">
  </a>
  <a href="https://docs.bmwu.cloud/">
   <img alt="Docs Status" src="https://img.shields.io/website/http/docs.bmwu.cloud?down_color=red&down_message=failing&up_message=success&label=docs">
  </a>
+ <a href="https://img.shields.io/pypi/dm/example-package">
+  <img alt="PyPI Downloads" src="https://img.shields.io/pypi/dm/example-package">
+ </a>
 </p>
 
-<h3 align="center">
- <p>北冥坞：学件基座系统</p>
- <p>学件范式的首次系统级实现</p>
- <p>
-  <a href="https://github.com/Learnware-LAMDA/Beimingwu/blob/main/README.md">English</a> |
+<p>
+ <h3 align="center">北冥坞：学件基座系统</h3>
+ <h3 align="center">学件范式的首次系统级实现</h3>
+ <h3 align="center">
+  <a href="README.md">English</a> |
   <b>中文</b>
- </p>
-</h3>
+ </h3>
+</p>
 
 # 简介
 
@@ -83,15 +83,15 @@
 ### 项目结构
 
 基于上述系统架构，北冥坞项目一共包含如下五个子项目：
-- [`系统引擎`](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://gitee.com/beimingwu/learnware)：实现了学件范式中的核心组件和算法，并提供了一个基于命令行的客户端以便于用户交互，同时将其作为 [learnware](https://pypi.org/project/learnware/) 包发布。
+- [`系统前端`](https://gitee.com/beimingwu/beimingwu/tree/main/frontend)：提供了用户与系统交互的界面和功能，包括主系统和管理员系统。
+- [`系统后端`](https://gitee.com/beimingwu/beimingwu/tree/main/backend)：负责处理系统的运行逻辑和数据操作，确保系统的稳定性和高性能。
+- [`系统文档`](https://gitee.com/beimingwu/beimingwu/tree/main/docs)：维护系统的文档，包括用户指南、开发指南等，确保系统的易用性。
+- [`系统部署`](https://gitee.com/beimingwu/beimingwu/tree/main/deploy)：负责管理系统的部署配置，包括前后端的部署文件。
 
 # 快速上手
 
-欢迎体验[北冥坞系统](https://bmwu.cloud/)！下述内容将帮你快速探索系统网站上的学件查搜功能，并基于 [learnware](https://github.com/Learnware-LAMDA/Learnware) 包提供两个从学件查搜至学件部署的应用案例。
+欢迎体验[北冥坞系统](https://bmwu.cloud/)！下述内容将帮你快速探索系统网站上的学件查搜功能，并基于 [learnware](https://gitee.com/beimingwu/learnware) 包提供两个从学件查搜至学件部署的应用案例。
 
 learnware 包的安装可参考：[环境安装](docs/content/zh-CN/overview/installation.md)。
 

diff --git a/docs/content/en/developer-guide/structure-and-guidelines.md b/docs/content/en/developer-guide/structure-and-guidelines.md
@@ -1,6 +1,6 @@
 # Project Structure and Guidelines
 
-The Beimingwu system adopts a `Monorepo` code management approach, and the [code repository](https://github.com/Learnware-LAMDA/Beiming-System) contains four sub-projects:
+The Beimingwu system adopts a `Monorepo` code management approach, and the [code repository](https://gitee.com/beimingwu/beimingwu) contains four sub-projects:
 - **Frontend**: Provides the interface and functionality for user interaction with the learnware dock system, including the main system and administrator system.
 - **Backend**: Responsible for handling dock system's operation logic and data operations, ensuring system stability and high performance.
 - **Docs**: Maintains system documentation, including user guides, development guides, etc., ensuring system usability.

diff --git a/docs/content/en/overview/installation.md b/docs/content/en/overview/installation.md
@@ -16,9 +16,9 @@ pip install learnware==0.2.0.9 -i https://pypi.tuna.tsinghua.edu.cn/simple
 
 ## Install from Source Code
 
-The source code for the `learnware` package is also available on both [Gitee](https://gitee.com/Learnware-LAMDA/Learnware) and [Github](https://github.com/Learnware-LAMDA/Learnware) platforms. Users can download the source code from either platform for installation. Here is an example when using the Github platform:
+The source code for the `learnware` package is also available on [Gitee](https://gitee.com/beimingwu/beimingwu) platform. Users can download the source code from either platform for installation. Here is an example when using the Github platform:
 ```bash
-git clone https://github.com/Learnware-LAMDA/Learnware.git
+git clone https://gitee.com/beimingwu/beimingwu
 cd Learnware
 git fetch origin main
 git checkout main

diff --git a/docs/content/zh-CN/developer-guide/structure-and-guidelines.md b/docs/content/zh-CN/developer-guide/structure-and-guidelines.md
@@ -1,6 +1,6 @@
 # 项目结构与开发规范
 
-北冥坞系统采用了 `Monorepo` 的代码管理方式，[代码仓库](https://github.com/Learnware-LAMDA/Beiming-System)中一共包含四个子项目：
+北冥坞系统采用了 `Monorepo` 的代码管理方式，[代码仓库](https://gitee.com/beimingwu/beimingwu)中一共包含四个子项目：
 - **前端**：提供了用户与系统交互的界面和功能，包括主系统和管理员系统。
 - **后端**：负责处理系统的运行逻辑和数据操作，确保系统的稳定性和高性能。
 - **系统文档**：维护系统的文档，包括用户指南、开发指南等，确保系统的易用性。

diff --git a/docs/content/zh-CN/overview/installation.md b/docs/content/zh-CN/overview/installation.md
@@ -16,9 +16,9 @@ pip install learnware==0.2.0.9 -i https://pypi.tuna.tsinghua.edu.cn/simple
 
 ## 通过源码安装
 
-`learnware` 包的源代码同时发布在 [Gitee](https://gitee.com/Learnware-LAMDA/Learnware) 和 [Github](https://github.com/Learnware-LAMDA/Learnware) 平台上，用户也可以从任一平台下载源代码进行安装。以 Github 平台为例：
+`learnware` 包的源代码发布在 [Gitee](https://gitee.com/beimingwu/beimingwu) 平台上，用户也可以从任一平台下载源代码进行安装。以 Github 平台为例：
 ```bash
-git clone https://github.com/Learnware-LAMDA/Learnware.git
+git clone https://gitee.com/beimingwu/beimingwu
 cd Learnware
 git fetch origin main
 git checkout main