Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 9c3ef35

Browse files
qiaofeng1227qiaofeng1227
committed
change docs
1 parent 2bef5ef commit 9c3ef35

14 files changed

Lines changed: 36 additions & 109 deletions

File tree

‎appmanage/api/v1/routers/health.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,4 @@
44

55
@router.get("/health")
66
def health_check():
7-
return {"message": "StackHub API is alive"}
7+
return {"message": "stackhub API is alive"}

‎appmanage/docs/administrator.md‎

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,21 +4,19 @@
44

55
### 安装组件
66

7-
1. python环境
8-
确保安装python3.6+
7+
1. python 环境
8+
确保安装 python3.6+
99

10-
2. python的pip包fastapi,uvicorn[standard],gunicorn
10+
2. python 的 pip 包 fastapi,uvicorn[standard],gunicorn
1111

1212
```
1313
pip install -r requirements.txt
1414
```
1515

16-
3. 安装docker以及docker compose、创建docker 网络websoft9
16+
3. 安装 docker 以及 docker compose、创建 docker 网络 websoft9
1717

1818
### 启动
1919

2020
```
21-
git clone https://github.com/Websoft9/StackHub.git && cd StackHub/docker/appmanage && docker compose up -d
21+
git clone https://github.com/Websoft9/stackhub.git && cd stackhub/docker/appmanage && docker compose up -d
2222
```
23-
24-

‎cli/data/application.list‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ Websoft9/role_docker Install Docker and some applications on Docker public 2021-
33
Websoft9/ansible-superset Automatic installation for Apache Superset on Linux public 2021-09-26T03:19:56Z
44
Websoft9/ansible-gitlab Automatic installation for GitLab on Linux public 2021-09-24T09:57:37Z
55
Websoft9/docker-falcon Docker Compose to deploy Falcon-Plus in production public, fork 2021-09-24T02:58:00Z
6-
Websoft9/StackHub CLI to install hot open source stacks public 2021-09-23T10:06:45Z
6+
Websoft9/stackhub CLI to install hot open source stacks public 2021-09-23T10:06:45Z
77
Websoft9/ansible-ansible This repository is only for developer who want to testing and learning Ansible public 2021-09-18T11:08:52Z
88
Websoft9/ansible-jenkins Automatic installation for Jenkins on Linux public 2021-09-18T03:40:34Z
99
Websoft9/docker-wordpress Docker Compose to deploy WordPress in production public, fork 2021-09-18T02:23:33Z

‎docs/PRD.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# 需求
22

3-
从两个主线理解 StackHub 的需求：
3+
从两个主线理解 stackhub 的需求：
44

55
- 应用生命周期管理：寻找、安装、发布、停止、卸载、升级等软件全生命周期。
66
- 基础设施运维管理：安全、存储、文件、容器、监控等系统管理
@@ -108,7 +108,7 @@ UI 自适应各种屏幕尺寸
108108
一键自动化安装程序，类似：
109109

110110
```
111-
curl https://websoft9.github.io/StackHub/install/install.sh | bash
111+
curl https://websoft9.github.io/stackhub/install/install.sh | bash
112112
```
113113

114114
主要步骤包括：

‎docs/administrator.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,11 @@
44

55
1. 将 APP 的版本号、最小 CPU、内存、磁盘空间同步到 Contenful 数据表，通过自动化[Github Action](https://github.com/Websoft9/docker-library/blob/main/.github/workflows/requirement_to_contentful.yml)实现。
66

7-
2. 将 logo 图片同步到 Stackhub 项目的静态文件夹(/static/images)，通过自动化[Github Action](https://github.com/Websoft9/StackHub/blob/main/.github/workflows/logo.yml)实现。
7+
2. 将 logo 图片同步到 Stackhub 项目的静态文件夹(/static/images)，通过自动化[Github Action](https://github.com/Websoft9/stackhub/blob/main/.github/workflows/logo.yml)实现。
88

99
## AppManage 镜像生成
1010

11-
发布镜像到 Dockhub 的 websoft9dev 组织下，通过自动化[Github Action](https://github.com/Websoft9/StackHub/blob/main/.github/workflows/appmanage_docker.yml)实现。
11+
发布镜像到 Dockhub 的 websoft9dev 组织下，通过自动化[Github Action](https://github.com/Websoft9/stackhub/blob/main/.github/workflows/appmanage_docker.yml)实现。
1212

1313
## 日志
1414

‎docs/architecture.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
## 架构图
22

3-
![image](https://github.com/Websoft9/StackHub/assets/43192516/3b52f27a-8dff-477b-acea-cf971096540c)
3+
![image](https://github.com/Websoft9/stackhub/assets/43192516/3b52f27a-8dff-477b-acea-cf971096540c)
44

55
## 详细
66

‎docs/developer.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ cancel_jobs = cancel.get_job_ids()
6969

7070
### API 文档
7171

72-
[FastAPI 文档](https://github.com/Websoft9/StackHub/blob/main/appmanage/docs/developer.md) 使用 swagger 自动生成，访问地址：http://IP:PORT/docs。
72+
[FastAPI 文档](https://github.com/Websoft9/stackhub/blob/main/appmanage/docs/developer.md) 使用 swagger 自动生成，访问地址：http://IP:PORT/docs。
7373

7474
## 版本管理
7575

@@ -109,7 +109,7 @@ Websoft9 的 release 的版本号由项目主版本号和各微服务和插件
109109
"Ubuntu": ["18.04","20.04","22.04"],
110110
"RedHat": ["7.9","8.6","9.2"]
111111
},
112-
"VERSION": "0.7.0" // StackHub项目版本号，上面所有组件的更新都会引起其版本更新
112+
"VERSION": "0.7.0" // stackhub项目版本号，上面所有组件的更新都会引起其版本更新
113113
}
114114
```
115115

@@ -138,9 +138,9 @@ Dockerhub, Github packages, Azure artifacts, CODING 制品库
138138
139139
#### 制品库自动化
140140

141-
* 插件制品管理：开发人员开发测试完成后，修改插件版本，触发 Action 构建 Github packages 制品
142-
* docker-libaray 库制品管理：开发人员测试完成后，修改 library 版本，触发 Action 构建 Github packages 制品
143-
* websoft9 制品管理：开发人员修改 appmanage 源码或微服务 docker-compose 测试完成后，修改 微服务 版本，触发 Action 构建 Dockerhub 镜像制品以及后台微服务 Github packages 制品
141+
- 插件制品管理：开发人员开发测试完成后，修改插件版本，触发 Action 构建 Github packages 制品
142+
- docker-libaray 库制品管理：开发人员测试完成后，修改 library 版本，触发 Action 构建 Github packages 制品
143+
- websoft9 制品管理：开发人员修改 appmanage 源码或微服务 docker-compose 测试完成后，修改 微服务 版本，触发 Action 构建 Dockerhub 镜像制品以及后台微服务 Github packages 制品
144144

145145
> Portainer,redis,nginxproxymanager 使用外部 dockerhub 镜像
146146

‎install/install.sh‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ function error_exit {
66
echo "$1" 1>&2
77
exit 1
88
}
9-
trap 'error_exit "Please push issue to: https://github.com/Websoft9/StackHub/issues"' ERR
9+
trap 'error_exit "Please push issue to: https://github.com/Websoft9/stackhub/issues"' ERR
1010

1111
urls=(
1212
https://github.com

‎install/install_release.sh‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ function error_exit {
66
echo "$1" 1>&2
77
exit 1
88
}
9-
trap 'error_exit "Please push issue to: https://github.com/Websoft9/StackHub/issues"' ERR
9+
trap 'error_exit "Please push issue to: https://github.com/Websoft9/stackhub/issues"' ERR
1010

1111
urls=(
1212
https://ghproxy.com/https://github.com
@@ -359,7 +359,7 @@ echo "fast url is: "$fasturl
359359
# download apps
360360
mkdir -p /data/apps
361361
clone_repo $fasturl/Websoft9/docker-library /data/library
362-
clone_repo $fasturl/Websoft9/StackHub /data/apps/stackhub
362+
clone_repo $fasturl/Websoft9/stackhub /data/apps/stackhub
363363
}
364364

365365
StartAppMng(){

‎install/update.sh‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ function error_exit {
66
echo "$1" 1>&2
77
exit 1
88
}
9-
trap 'error_exit "Please push issue to: https://github.com/Websoft9/StackHub/issues"' ERR
9+
trap 'error_exit "Please push issue to: https://github.com/Websoft9/stackhub/issues"' ERR
1010

1111
urls=(
1212
https://ghproxy.com/https://github.com
@@ -125,7 +125,7 @@ fi
125125
}
126126
StackhubUpdate(){
127127
echo "Update stackhub ..."
128-
cd /tmp && rm -rf version.json && wget https://websoft9.github.io/StackHub/install/version.json
128+
cd /tmp && rm -rf version.json && wget https://websoft9.github.io/stackhub/install/version.json
129129

130130
if [ ! -f /data/apps/stackhub/install/version.json ]; then
131131
old_version="0.0.1"
@@ -140,14 +140,14 @@ if [ "$old_version" \< "$release_version" ]; then
140140
echo "fasturl is: "$fasturl
141141
cd /tmp && rm -rf /tmp/stackhub
142142
if [[ $fasturl == *gitee.com* ]]; then
143-
wget $fasturl/websoft9/StackHub/repository/archive/$release_version
143+
wget $fasturl/websoft9/stackhub/repository/archive/$release_version
144144
unzip $release_version
145-
mv StackHub* stackhub
145+
mv stackhub* stackhub
146146
rm -f $release_version
147147
else
148-
wget $fasturl/websoft9/StackHub/archive/refs/tags/$release_version.zip
148+
wget $fasturl/websoft9/stackhub/archive/refs/tags/$release_version.zip
149149
unzip $release_version.zip
150-
mv StackHub* stackhub
150+
mv stackhub* stackhub
151151
rm -f $release_version.zip
152152
fi
153153
rm -rf /data/apps/stackhub

0 commit comments

Comments
 (0)