eliott/Olares
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: update Developer Guide and Concepts sections in Olares (#1816)

Browse Source 
* Content modification

1. Hide Recommendation
2. Update link of LLDAP
3. Update content of Service system

* Jump link reset

* Additional changes
This commit is contained in:
Meow33
2025-09-10 21:01:31 +08:00
committed by GitHub
parent 255af9e472
commit 93a20fa397
37 changed files with 73 additions and 73 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
docs/zh/developer/develop/tutorial/note/create.md
View File

@@ -4,10 +4,10 @@ outline: [2, 3]
# 如何开始开发一个应用
## 下载并安装 DevBox
## 下载并安装 Studio
1. 从 Olares 应用市场安装 [DevBox](https://market.olares.com/app/devbox)。
2. 在 Olares 桌面的 LaunchPad 中找到 DevBox 图标。
1. 从 Olares 应用市场安装 [Studio](https://market.olares.com/app/studio)。
2. 在 Olares 桌面的 LaunchPad 中找到 Studio 图标。
3. 点击图标启动应用程序。
![main screen](/images/developer/develop/tutorial/create/home.jpg)
@@ -24,7 +24,7 @@ outline: [2, 3]
## 设置应用配置
创建应用程序后，你可以在 **Files** 选项卡下看到 DevBox 生成的 Olares Application Chart 文件。你可以根据需要添加、删除或重命名各种配置文件。
创建应用程序后，你可以在 **Files** 选项卡下看到 Studio 生成的 Olares Application Chart 文件。你可以根据需要添加、删除或重命名各种配置文件。
![upload icon](/images/developer/develop/tutorial/create/add-file.jpg)
@@ -107,7 +107,7 @@ volumes:
`templates` 文件夹中的 `deployment.yaml` 详细描述了应用的部署配置。
如果你的应用分为前后端两个不同的容器。你可以在 templates 的部署文件中，添加多个容器。DevBox 将识别这些不同的容器并将它们分别绑定到不同的开发容器。例如，
如果你的应用分为前后端两个不同的容器。你可以在 templates 的部署文件中，添加多个容器。Studio 将识别这些不同的容器并将它们分别绑定到不同的开发容器。例如，
```yaml
containers:
# 前端容器
@@ -174,7 +174,7 @@ containers:
![containers](/images/developer/develop/tutorial/create/bind.jpg)
你可以为绑定的开发容器设置一个指定的开发环境，目前 DevBox 支持 NodeJS、Golang、python 三种开发容器。让我们给 demo 前端容器绑定一个 NodeJS 开发容器，给 Server 容器绑定一个 Golang 的开发容器。
你可以为绑定的开发容器设置一个指定的开发环境，目前 Studio 支持 NodeJS、Golang、python 三种开发容器。让我们给 demo 前端容器绑定一个 NodeJS 开发容器，给 Server 容器绑定一个 Golang 的开发容器。
这里选择了创建一个新的开发容器。如果之前已经创建过未绑定的开发容器，这里也可以选择一个已有的容器进行绑定。

2
docs/zh/developer/develop/tutorial/note/frontend.md
View File

@@ -1,7 +1,7 @@
# 开始前端程序开发
## 预览应用
应用安装完成后，可以通过 DevBox 的**预览**按钮，预览应用的前端效果。
应用安装完成后，可以通过 Studio 的**预览**按钮，预览应用的前端效果。
![preview](/images/developer/develop/tutorial/frontend/preview.jpg)

6
docs/zh/developer/develop/tutorial/note/index.md
View File

@@ -1,6 +1,6 @@
# 创建你的首个 Olares 应用
你可以通过本教程学习如何使用 DevBox 开发一个 Olares 应用。
你可以通过本教程学习如何使用 Studio 开发一个 Olares 应用。
整个教程以开发一个简单的 [Note](https://github.com/beclab/terminus-app-demo) 工具为例。展示如何从创建应用开始，开发一个完整的 Olares 应用。
@@ -10,7 +10,7 @@
展示如何创建一个 Olares 应用，并逐步配置这个应用的初始化开发环境。
2. [开发后端](./backend.md)<br>
学习如何利用 DevBox 的 IDE 完成后端 Golang 程序的开发，并为前端提供 API 接口。
学习如何利用 Studio 的 IDE 完成后端 Golang 程序的开发，并为前端提供 API 接口。
3. [开发前端](./frontend.md)<br>
以 NodeJS 为例，学习如何在 DevBox 的提供的 IDE 中开始前端页面的相关开发。
以 NodeJS 为例，学习如何在 Studio 的提供的 IDE 中开始前端页面的相关开发。

14
docs/zh/developer/develop/tutorial/studio.md
View File

@@ -1,13 +1,13 @@
# 了解 DevBox
# 了解 Studio
在 Olares 中，我们为每个开发者提供了一个为 Olares 开发应用的开发工具，这就是 DevBox。
在 Olares 中，我们为每个开发者提供了一个为 Olares 开发应用的开发工具，这就是 Studio 。
- 开发者为什么需要 DevBox 呢？
- 开发者为什么需要 Studio 呢？
Olares 作为一个具有诸多云原生特性的系统，有大量的系统上下文环境在开发者的单机开发环境很难模拟。同时，Olares 独有的沙盒体系也需要在真实的系统环境中才能完成 End to End 的测试。所以，为了方便开发者能够最便捷的获得真实的应用仿真体验，减少开发中的系统联调尝试，我们提供 DevBox 为开发者提供自动快速构建应用沙盒的开发工具集。
Olares 作为一个具有诸多云原生特性的系统，有大量的系统上下文环境在开发者的单机开发环境很难模拟。同时，Olares 独有的沙盒体系也需要在真实的系统环境中才能完成 End to End 的测试。所以，为了方便开发者能够最便捷的获得真实的应用仿真体验，减少开发中的系统联调尝试，我们提供 Studio 为开发者提供自动快速构建应用沙盒的开发工具集。
- DevBox 提供了哪些功能？
- Studio 提供了哪些功能？
- 在 DevBox 中，你可以创建一个应用，生成 Olares 应用的 Chart 包。接着你可以修改这个应用 Chart 的部署脚本，移植一个现有的应用，以 Olares 的方式部署到系统中。在修改过程中，你可以尝试安装，检查错误。测试通过后，可下载对应的应用 Chart，提交给 Olares 的 [Market 仓库](https://github.com/beclab/apps)。
- 在 Studio 中，你可以创建一个应用，生成 Olares 应用的 Chart 包。接着你可以修改这个应用 Chart 的部署脚本，移植一个现有的应用，以 Olares 的方式部署到系统中。在修改过程中，你可以尝试安装，检查错误。测试通过后，可下载对应的应用 Chart，提交给 Olares 的 [Market 仓库](https://github.com/beclab/apps)。
- 除了移植现有应用，你还可以创建一个全新的应用，在 DevBox 完成整个应用的开发到上线的工作。DevBox 中提供了在线的开发容器，开发者可以在真实的环境中完成代码开发，在程序中调用系统的其他接口或者数据库集群等等。
- 除了移植现有应用，你还可以创建一个全新的应用，在 Studio 完成整个应用的开发到上线的工作。Studio 中提供了在线的开发容器，开发者可以在真实的环境中完成代码开发，在程序中调用系统的其他接口或者数据库集群等等。