refactor docs.
This commit is contained in:
kaichao
parent
8efac53e87
commit
3bb23d5288
|
|
@ -0,0 +1,4 @@
|
|||
|
||||
|
||||
## 参考文档
|
||||
- [Welcome to Rucio's documentation](https://rucio.cern.ch/documentation/)
|
||||
|
|
@ -0,0 +1,5 @@
|
|||
# 2. Contact Us
|
||||
|
||||
## email
|
||||
|
||||
help@scalebox.dev
|
||||
|
|
@ -0,0 +1,23 @@
|
|||
# 1. Project Contributors
|
||||
|
||||
The following are the relevant people/teams who have contributed to this project, divided into three categories: historical contributors, external cooperation teams, and current R&D teams.
|
||||
|
||||
## Historical contributors
|
||||
- Qiancheng Wei, 2018~2020
|
||||
- Yuming Wang, 2019~2022
|
||||
- Yaochen Zhou, 2020~2023
|
||||
|
||||
## External cooperation teams
|
||||
- Chenhui Niu, 2020~
|
||||
- Tianmeng Zhang, 2019~2020
|
||||
- Chao Liu, 2019~
|
||||
- Bo Zhang, 2021~
|
||||
- Mengyao Xue, 2023~
|
||||
- Honghai Zhang, 2021~
|
||||
|
||||
## current R&D teams
|
||||
- Kaichao Wu, 2018~
|
||||
- Xiaoli Zhang, 2018~
|
||||
- Jianing Zhang, 2018~
|
||||
- Zihan Zhang, 2021~
|
||||
- Han Zhou, 2022~
|
||||
|
|
@ -0,0 +1 @@
|
|||
# 2. Application Definition File
|
||||
|
|
@ -0,0 +1 @@
|
|||
# 1. Command Line
|
||||
|
|
@ -0,0 +1 @@
|
|||
# 6. Advanced Programming Features
|
||||
|
|
@ -0,0 +1 @@
|
|||
# 3. Application Design and Impl
|
||||
|
|
@ -0,0 +1,4 @@
|
|||
# 2. Application Specification
|
||||
|
||||
## Best Practices
|
||||
|
||||
|
|
@ -0,0 +1 @@
|
|||
# 5. Common Programming Features
|
||||
|
|
@ -0,0 +1 @@
|
|||
# 4. Module Design and Impl
|
||||
|
|
@ -0,0 +1 @@
|
|||
# 1. Programming Model
|
||||
|
|
@ -1,4 +0,0 @@
|
|||
# Programming Model
|
||||
|
||||
Programming Model
|
||||
|
||||
|
|
@ -1,3 +1,11 @@
|
|||
# FAQ
|
||||
# 7. FAQ
|
||||
|
||||
Frequently Asked Questions
|
||||
|
||||
## 1.
|
||||
|
||||
## 2.
|
||||
|
||||
|
||||
|
||||
|
||||
faq
|
||||
|
|
|
|||
|
|
@ -1,3 +0,0 @@
|
|||
# Getting Help
|
||||
|
||||
getting help
|
||||
|
|
@ -1,35 +1,65 @@
|
|||
.. scalebox documentation master file, created by
|
||||
sphinx-quickstart on Mon Jan 29 06:19:06 2024.
|
||||
.. Scalebox documentation master file, created by
|
||||
sphinx-quickstart on Sun Jan 21 09:48:07 2024.
|
||||
You can adapt this file completely to your liking, but it should at least
|
||||
contain the root `toctree` directive.
|
||||
|
||||
Welcome to scalebox's documentation!
|
||||
Welcome to Scalebox Documentation!
|
||||
====================================
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
:caption: Introduction
|
||||
:caption: Get Started
|
||||
:hidden:
|
||||
|
||||
introduction/research_background
|
||||
introduction/programming_framework
|
||||
started/what_is_scalebox
|
||||
started/research_background
|
||||
started/parallel_programming
|
||||
started/architecture
|
||||
started/concepts/index
|
||||
started/requirements
|
||||
faq
|
||||
help
|
||||
release_notes
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
:caption: User Guide
|
||||
:hidden:
|
||||
|
||||
user_guide/architecture
|
||||
|
||||
user/head_install
|
||||
user/node_install
|
||||
user/common_modules
|
||||
user/app_examples
|
||||
user/cmdline
|
||||
user/webui
|
||||
user/adminer
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
:caption: Developer Guide
|
||||
:hidden:
|
||||
|
||||
developer_guide/programming_model
|
||||
|
||||
developer/programming_model
|
||||
developer/app_spec
|
||||
developer/app_impl
|
||||
developer/module_impl
|
||||
developer/common_features
|
||||
developer/advanced_features
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
:caption: Appendix
|
||||
:hidden:
|
||||
|
||||
appendix/cmdline
|
||||
appendix/app_def
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
:caption: About Us
|
||||
:hidden:
|
||||
|
||||
about_us/contributors
|
||||
about_us/contact_us
|
||||
|
||||
Indices and tables
|
||||
==================
|
||||
|
|
|
|||
|
|
@ -1,3 +0,0 @@
|
|||
# Parallel Programming
|
||||
|
||||
Parallel Programming
|
||||
|
|
@ -1,3 +0,0 @@
|
|||
# Research Background
|
||||
|
||||
Research Background
|
||||
|
|
@ -0,0 +1,2 @@
|
|||
# 8. Release Notes
|
||||
|
||||
|
|
@ -0,0 +1 @@
|
|||
# 4. Architecture
|
||||
|
|
@ -0,0 +1,2 @@
|
|||
# 5. Concepts
|
||||
|
||||
|
|
@ -0,0 +1 @@
|
|||
# 3. Parallel Programming
|
||||
|
|
@ -0,0 +1 @@
|
|||
# 6. Requirements
|
||||
|
|
@ -0,0 +1,2 @@
|
|||
# 2. Research Background
|
||||
|
||||
|
|
@ -0,0 +1,8 @@
|
|||
# 1. What is Scalebox?
|
||||
|
||||
## History
|
||||
|
||||
## What can Scalebox do
|
||||
|
||||
## What Scalebox doesn't do
|
||||
|
||||
|
|
@ -0,0 +1 @@
|
|||
# 7. Database Tool
|
||||
|
|
@ -0,0 +1,5 @@
|
|||
# 4. Application Examples
|
||||
|
||||
## 4.1 hello, scalebox
|
||||
|
||||
## 4.2 app-primes
|
||||
|
|
@ -0,0 +1,2 @@
|
|||
# 5. Client Tool
|
||||
|
||||
|
|
@ -0,0 +1,2 @@
|
|||
# 3. Common Modules
|
||||
|
||||
|
|
@ -0,0 +1,2 @@
|
|||
# 1. Head Node Install
|
||||
|
||||
|
|
@ -0,0 +1,2 @@
|
|||
# 2. Compute Node Install
|
||||
|
||||
|
|
@ -0,0 +1 @@
|
|||
# 6. WebUI
|
||||
|
|
@ -1,3 +0,0 @@
|
|||
# 系统架构
|
||||
|
||||
系统架构
|
||||
|
|
@ -0,0 +1,7 @@
|
|||
# 2. 联系我们
|
||||
|
||||
|
||||
|
||||
## 邮件联系方式
|
||||
|
||||
help@scalebox.dev
|
||||
|
|
@ -0,0 +1,23 @@
|
|||
# 1. 项目贡献者
|
||||
|
||||
以下是对本项目做出过贡献的相关人员/团队，分为历史贡献者、外部合作团队、当前研发团队三类。
|
||||
|
||||
## 历史贡献者
|
||||
- 魏千程，2018~2020
|
||||
- 王玉明，2019~2022
|
||||
- 周耀辰，2020~2023
|
||||
|
||||
## 外部合作团队
|
||||
- 牛晨辉，2020~
|
||||
- 张天萌，2019~2020
|
||||
- 刘超，2019~
|
||||
- 章博，2021~
|
||||
- 薛梦瑶，2023~
|
||||
- 张宏海，2021~
|
||||
|
||||
## 当前研发团队
|
||||
- 吴开超，2018~
|
||||
- 张晓丽，2018~
|
||||
- 唐家宁，2018~
|
||||
- 张子涵，2021~
|
||||
- 周晗，2022~
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
# 1. 命令行工具
|
||||
|
||||
命令行工具scalebox
|
||||
|
|
@ -1,4 +1,4 @@
|
|||
# 3. FAQ
|
||||
# 7. 常见问答集
|
||||
|
||||
Frequently Asked Questions
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +0,0 @@
|
|||
# 4. 获取帮助
|
||||
|
||||
|
||||
help@scalebox.dev
|
||||
|
|
@ -3,48 +3,63 @@
|
|||
You can adapt this file completely to your liking, but it should at least
|
||||
contain the root `toctree` directive.
|
||||
|
||||
Welcome to Scalebox's documentation!
|
||||
欢迎来到Scalebox的文档库!
|
||||
====================================
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
:caption: 引言
|
||||
:caption: 入门教程
|
||||
:hidden:
|
||||
|
||||
introduction/research_background
|
||||
introduction/parallel_programming
|
||||
started/what_is_scalebox
|
||||
started/research_background
|
||||
started/parallel_programming
|
||||
started/architecture
|
||||
started/concepts/index
|
||||
started/requirements
|
||||
faq
|
||||
help
|
||||
release_notes
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
:caption: 使用指南
|
||||
:hidden:
|
||||
|
||||
user_guide/architecture
|
||||
user_guide/install
|
||||
user_guide/common_modules
|
||||
user_guide/app_examples
|
||||
user/head_install
|
||||
user/node_install
|
||||
user/common_modules
|
||||
user/app_examples
|
||||
user/cmdline
|
||||
user/webui
|
||||
user/adminer
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
:caption: 开发指南
|
||||
:hidden:
|
||||
|
||||
developer_guide/programming_model
|
||||
developer_guide/app_spec
|
||||
developer_guide/app_impl
|
||||
developer_guide/module_impl
|
||||
developer_guide/common_features
|
||||
developer_guide/advanced_features
|
||||
developer/programming_model
|
||||
developer/app_spec
|
||||
developer/app_impl
|
||||
developer/module_impl
|
||||
developer/common_features
|
||||
developer/advanced_features
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
:caption: 引用文档
|
||||
:caption: 附录
|
||||
:hidden:
|
||||
|
||||
references/cmdline
|
||||
references/app_def
|
||||
appendix/cmdline
|
||||
appendix/app_def
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
:caption: 关于我们
|
||||
:hidden:
|
||||
|
||||
about_us/contributors
|
||||
about_us/contact_us
|
||||
|
||||
Indices and tables
|
||||
==================
|
||||
|
|
|
|||
|
|
@ -1,3 +0,0 @@
|
|||
# 2. 并行编程
|
||||
|
||||
并行编程
|
||||
|
|
@ -1,2 +0,0 @@
|
|||
# 1. 研究背景
|
||||
|
||||
|
|
@ -1,3 +0,0 @@
|
|||
# 1. 命令行工具scalebox
|
||||
|
||||
命令行工具scalebox
|
||||
|
|
@ -0,0 +1,2 @@
|
|||
# 8. 发布说明
|
||||
|
||||
|
|
@ -1,4 +1,6 @@
|
|||
# 1. 系统架构
|
||||
# 4. 系统架构
|
||||
|
||||
（主要组件）
|
||||
|
||||
## 1.1 主要术语定义
|
||||
|
||||
|
|
@ -0,0 +1,2 @@
|
|||
# 5. 技术概念
|
||||
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
# 3. 并行编程
|
||||
|
||||
并行编程
|
||||
|
|
@ -1,6 +1,4 @@
|
|||
# 2. 安装Scalebox
|
||||
|
||||
## 2.1 系统环境需求
|
||||
# 6. 环境需求
|
||||
|
||||
### 芯片架构及操作系统
|
||||
|
||||
|
|
@ -21,9 +19,3 @@
|
|||
| singularity | 3.8<sup>+</sup> | |
|
||||
| containerd + nerdctl | 1.6<sup>+</sup> | 待测试 |
|
||||
|
||||
|
||||
|
||||
## 2.2 头节点安装
|
||||
|
||||
## 2.3 计算节点安装
|
||||
|
||||
|
|
@ -0,0 +1,2 @@
|
|||
# 2. 研究背景
|
||||
|
||||
|
|
@ -0,0 +1,8 @@
|
|||
# 1. Scalebox是什么？
|
||||
|
||||
## Scalebox历史
|
||||
|
||||
## Scalebox能做什么？
|
||||
|
||||
## Scalebox不能做什么？
|
||||
|
||||
|
|
@ -0,0 +1 @@
|
|||
# 7. 数据库工具
|
||||
|
|
@ -0,0 +1,2 @@
|
|||
# 5. 客户端工具
|
||||
|
||||
|
|
@ -0,0 +1,2 @@
|
|||
# 1. 头节点安装
|
||||
|
||||
|
|
@ -0,0 +1,2 @@
|
|||
# 2. 计算节点安装
|
||||
|
||||
|
|
@ -0,0 +1 @@
|
|||
# 6. WebUI工具
|
||||
Loading…
Reference in New Issue