Skip to content

Commit

Permalink
fix broken links
Browse files Browse the repository at this point in the history
Signed-off-by: 周鹏飞@yunify <pengfeizhou@yunify.com>
  • Loading branch information
周鹏飞@yunify committed Jul 11, 2019
1 parent d1c0638 commit a862cc6
Show file tree
Hide file tree
Showing 16 changed files with 36 additions and 113 deletions.
2 changes: 1 addition & 1 deletion docs/v0.3/zh-CN/contribution/contribution-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ OpenPitrix 从一开始就是以开源的方式来进行,并且在 2017 年的

### 搭建开发环境

参见 [搭建开发环境](../set-up-env) 搭建本地开发环境并运行项目预览前端界面。
参见 [搭建开发环境](../contribution/set-up-env) 搭建本地开发环境并运行项目预览前端界面。

### 搭建 DevOps 环境

Expand Down
4 changes: 2 additions & 2 deletions docs/v0.3/zh-CN/developer-guide/helm-developer-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ nginx/
2 directories, 7 files
```

Chart.yaml 是用于描述 Chart 的基本信息,包括名称、API 和应用版本等,其中 appVersion 字段与 version 字段无关。这是一种指定应用程序版本的方法详见 [Chart.yaml 文件](../helm-specification/#chartyaml-文件)
Chart.yaml 是用于描述 Chart 的基本信息,包括名称、API 和应用版本等,其中 appVersion 字段与 version 字段无关。这是一种指定应用程序版本的方法详见 [Chart.yaml 文件](../developer-guide/helm-specification)

**Chart.yaml 文件示例:**

Expand Down Expand Up @@ -114,7 +114,7 @@ affinity: {}

```
可根据 [Helm 应用开发规范](../helm-specification) 编辑 nginx 目录下文件,编辑好后保存。
可根据 [Helm 应用开发规范](../developer-guide/helm-specification) 编辑 nginx 目录下文件,编辑好后保存。
### 生成索引文件(可选)
Expand Down
14 changes: 7 additions & 7 deletions docs/v0.3/zh-CN/developer-guide/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,25 +4,25 @@ title: "简介"

OpenPitrix 要求开发者按照一定的应用打包规范上传应用,目前支持两种开发规范:

* [OpenPitrix 开发规范](../openpitrix-specification)
* [Helm Chart 开发规范](../helm-specification)
* [OpenPitrix 开发规范](../developer-guide/openpitrix-specification)
* [Helm Chart 开发规范](../developer-guide/helm-specification)

### OpenPitrix 开发规范

沿用的 [QingCloud AppCenter 开发规范](https://docs.qingcloud.com/appcenter/docs/specifications/specifications.html),并做了升级和优化,采用该规范开发的应用,可以部署到基于 VM 的云运行时环境中,如 AWS、QingCloud 等。

[OpenPitrix 开发入门](../openpitrix-developer-guide) 提供了一个 Wordpress 示例,指导用户制作镜像,给出配置文件的模板,帮助用户熟悉 OpenPitrix 应用开发的流程。
[OpenPitrix 开发入门](../developer-guide/openpitrix-developer-guide) 提供了一个 Wordpress 示例,指导用户制作镜像,给出配置文件的模板,帮助用户熟悉 OpenPitrix 应用开发的流程。

[OpenPitrix 应用开发规范](../openpitrix-specification) 解释了 OpenPitrix 应用配置文件的格式和规范,提供配置的基本指导。
[OpenPitrix 应用开发规范](../developer-guide/openpitrix-specification) 解释了 OpenPitrix 应用配置文件的格式和规范,提供配置的基本指导。

[OpenPitrix 应用开发流程](../packaging-openpitrix-app) 描述了准备一个 OpenPitrix 应用的基本流程。
[OpenPitrix 应用开发流程](../developer-guide/packaging-openpitrix-app) 描述了准备一个 OpenPitrix 应用的基本流程。


### Helm Chart 开发规范

[Helm](https://helm.sh) 是 Kubernetes 的应用包管理器,Helm 使用一种称为 Chart 的包装格式,Chart 是描述相关的一组 Kubernetes 资源的文件集合。Chart 通过创建特定目录树的文件,将它们打包到版本化的压缩包。采用 [Helm Chart](https://docs.helm.sh) 规范开发的应用,可以部署到 Kubernetes 环境中。

[Helm Chart 开发入门](../helm-developer-guide) 提供一个应用示例,帮助用户熟悉 Helm Chart 的基本步骤。
[Helm Chart 开发入门](../developer-guide/helm-developer-guide) 提供一个应用示例,帮助用户熟悉 Helm Chart 的基本步骤。

[Helm Chart 开发模板规范](../helm-specification) 解释了 Chart 格式,提供使用 Helm 构建 Chart 的基本指导。
[Helm Chart 开发模板规范](../developer-guide/helm-specification) 解释了 Chart 格式,提供使用 Helm 构建 Chart 的基本指导。

Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ $ mkdir Wordpress

### 第三步:准备配置文件

其中 cluster.json.tmpl,config.json,package.json 这三个配置文件是必须的,详见 [开发模板规范](../openpitrix-specification)
其中 cluster.json.tmpl,config.json,package.json 这三个配置文件是必须的,详见 [开发模板规范](../developer-guide/openpitrix-specification)

**Wordpress/cluster.json.tmpl**

Expand Down
8 changes: 4 additions & 4 deletions docs/v0.3/zh-CN/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: "常见问题"

1、作为新手,如何从一个最简单的例子入手?

我们提供了一个如何准备一个基于 OpenPitrix 应用开发规范的示例,建议从 [ WordPress 实战](../developer-guide/openpitrix-developer-guide/#wordpress-实战) 入手,从零开始准备一个配置包并上传到 OpenPitrix 中,后续可参考 [用户指南](../user-guide/introduction) 熟悉应用的全生命周期管理。
我们提供了一个如何准备一个基于 OpenPitrix 应用开发规范的示例,建议从 [WordPress 实战](../zh-CN/developer-guide/openpitrix-developer-guide/#wordpress-实战) 入手,从零开始准备一个配置包并上传到 OpenPitrix 中,后续可参考 [用户指南](../zh-CN/user-guide/introduction) 熟悉应用的全生命周期管理。

2、应用如何语言国际化?

Expand All @@ -13,7 +13,7 @@ title: "常见问题"
- locale/en.json 英文翻译文件
- locale/zh-cn.json 中文翻译文件

具体配置请参考文档 [国际化](../developer-guide/openpitrix-specification/#国际化)
具体配置请参考文档 [国际化](../zh-CN/developer-guide/openpitrix-specification/#国际化)

3、上传配置包或新的版本时报错:配置验证失败,报 “创建资源失败” 错误?

Expand All @@ -23,11 +23,11 @@ title: "常见问题"

4、All-in-one 模式安装 OpenPitrix 时,卡在某一步进度一直没有变化,是什么原因?

可能是主机的配置规格不符合要求,比如内存不足,建议按照我们提供的 [all-in-one 模式 - 主机环境](../installation/allinone/#主机环境) 准备环境。
可能是主机的配置规格不符合要求,比如内存不足,建议按照我们提供的 [all-in-one 模式 - 主机环境](../zh-CN/installation/allinone/#主机环境) 准备环境。

5、All-in-one 模式安装 OpenPitrix 时,make 命令执行失败,为什么?

可能是依赖的软件版本不满足要求,可检查其版本并对照 [all-in-one 模式 - 软件环境](../installation/allinone/#软件环境) 安装符合要求的版本。
可能是依赖的软件版本不满足要求,可检查其版本并对照 [all-in-one 模式 - 软件环境](../zh-CN/installation/allinone/#软件环境) 安装符合要求的版本。

6、Kubernetes 模式执行安装脚本 deploy-k8s.sh 失败?

Expand Down
4 changes: 2 additions & 2 deletions docs/v0.4/zh-CN/contribution/contribution-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ OpenPitrix 从一开始就是以开源的方式来进行,并且在 2017 年的

- [安装指南](../installation/installation-guide):将 OpenPitrix 部署到自己的环境中开始试用和功能体验
- [快速入门](../getting-start/introduction):引导新用户快速上手 OpenPitrix
- [用户指南](../user-guide/introduction) :熟悉 OpenPitrix 的使用详情
- [用户指南](../manual-guide/introduction) :熟悉 OpenPitrix 的使用详情
- [项目设计](https://github.com/openpitrix/openpitrix/blob/master/docs/design/README.md):设计的基本思路就是解耦应用程序的仓库和运行时环境,应用程序可以通过匹配运行时环境的标签和应用来源的仓库选择器来运行。
- [Dashboard 贡献指南](https://github.com/openpitrix/dashboard/blob/master/CONTRIBUTING.md):如何为用户控制台的 repo 提交贡献。

Expand All @@ -44,7 +44,7 @@ OpenPitrix 从一开始就是以开源的方式来进行,并且在 2017 年的

### 搭建开发环境

参见 [搭建开发环境](../set-up-env) 搭建本地开发环境并运行项目预览前端界面。
参见 [搭建开发环境](../contribution/set-up-env) 搭建本地开发环境并运行项目预览前端界面。

### 搭建 DevOps 环境

Expand Down
2 changes: 1 addition & 1 deletion docs/v0.4/zh-CN/contribution/open-source-intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ OpenPitrix 从一开始就是以开源的方式来进行,并且在 2017 年的

- [安装指南](../installation/installation-guide):将 OpenPitrix 部署到自己的环境中开始试用和功能体验
- [快速入门](../getting-start):引导新用户快速上手 OpenPitrix
- [用户指南](../user-guide/introduction) :熟悉 OpenPitrix 的使用详情
- [用户指南](../manual-guide/introduction) :熟悉 OpenPitrix 的使用详情
- [项目设计](https://github.com/openpitrix/openpitrix/blob/master/docs/design/README.md)

### 发现可以参与的事情
Expand Down
2 changes: 1 addition & 1 deletion docs/v0.4/zh-CN/contribution/set-up-env.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ $ docker container ls | grep dashboard
![OpenPitrix 主页](/dashboard.png)

OpenPitrix 部署成功后,可以使用以下的管理员默认的用户名和密码登录 OpenPitrix 控制台体验,参见 [用户管理](../user-guide/user-management) 创建开发者和普通用户的角色,[快速入门](../getting-start/introduction) 将帮助您快速上手 OpenPitrix。
OpenPitrix 部署成功后,可以使用以下的管理员默认的用户名和密码登录 OpenPitrix 控制台体验,参见 [用户管理](../manual-guide/user-management) 创建开发者和普通用户的角色,[快速入门](../getting-start/introduction) 将帮助您快速上手 OpenPitrix。


| 角色 | 用户名 | 密码 |
Expand Down
4 changes: 2 additions & 2 deletions docs/v0.4/zh-CN/developer-guide/helm-developer-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ nginx/
2 directories, 7 files
```

Chart.yaml 是用于描述 Chart 的基本信息,包括名称、API 和应用版本等,其中 appVersion 字段与 version 字段无关。这是一种指定应用程序版本的方法详见 [Chart.yaml 文件](../helm-specification/#chartyaml-文件)
Chart.yaml 是用于描述 Chart 的基本信息,包括名称、API 和应用版本等,其中 appVersion 字段与 version 字段无关。这是一种指定应用程序版本的方法详见 [Chart.yaml 文件](../developer-guide/helm-specification/#chartyaml-文件)

**Chart.yaml 文件示例:**

Expand Down Expand Up @@ -114,7 +114,7 @@ affinity: {}

```
可根据 [Helm 应用开发规范](../helm-specification) 编辑 nginx 目录下文件,编辑好后保存。
可根据 [Helm 应用开发规范](../developer-guide/helm-specification) 编辑 nginx 目录下文件,编辑好后保存。
### 生成索引文件(可选)
Expand Down
14 changes: 7 additions & 7 deletions docs/v0.4/zh-CN/developer-guide/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,25 +4,25 @@ title: "简介"

OpenPitrix 要求开发者按照一定的应用打包规范上传应用,目前支持两种开发规范:

* [OpenPitrix 开发规范](../openpitrix-specification)
* [Helm Chart 开发规范](../helm-specification)
* [OpenPitrix 开发规范](../developer-guide/openpitrix-specification)
* [Helm Chart 开发规范](../developer-guide/helm-specification)

### OpenPitrix 开发规范

沿用的 [QingCloud AppCenter 开发规范](https://docs.qingcloud.com/appcenter/docs/specifications/specifications.html),并做了升级和优化,采用该规范开发的应用,可以部署到基于 VM 的云运行时环境中,如 AWS、QingCloud 等。

[OpenPitrix 开发入门](../openpitrix-developer-guide) 提供了一个 Wordpress 示例,指导用户制作镜像,给出配置文件的模板,帮助用户熟悉 OpenPitrix 应用开发的流程。
[OpenPitrix 开发入门](../developer-guide/openpitrix-developer-guide) 提供了一个 Wordpress 示例,指导用户制作镜像,给出配置文件的模板,帮助用户熟悉 OpenPitrix 应用开发的流程。

[OpenPitrix 应用开发规范](../openpitrix-specification) 解释了 OpenPitrix 应用配置文件的格式和规范,提供配置的基本指导。
[OpenPitrix 应用开发规范](../developer-guide/openpitrix-specification) 解释了 OpenPitrix 应用配置文件的格式和规范,提供配置的基本指导。

[OpenPitrix 应用开发流程](../packaging-openpitrix-app) 描述了准备一个 OpenPitrix 应用的基本流程。
[OpenPitrix 应用开发流程](../developer-guide/packaging-openpitrix-app) 描述了准备一个 OpenPitrix 应用的基本流程。


### Helm Chart 开发规范

[Helm](https://helm.sh) 是 Kubernetes 的应用包管理器,Helm 使用一种称为 Chart 的包装格式,Chart 是描述相关的一组 Kubernetes 资源的文件集合。Chart 通过创建特定目录树的文件,将它们打包到版本化的压缩包。采用 [Helm Chart](https://docs.helm.sh) 规范开发的应用,可以部署到 Kubernetes 环境中。

[Helm Chart 开发入门](../helm-developer-guide) 提供一个应用示例,帮助用户熟悉 Helm Chart 的基本步骤。
[Helm Chart 开发入门](../developer-guide/helm-developer-guide) 提供一个应用示例,帮助用户熟悉 Helm Chart 的基本步骤。

[Helm Chart 开发模板规范](../helm-specification) 解释了 Chart 格式,提供使用 Helm 构建 Chart 的基本指导。
[Helm Chart 开发模板规范](../developer-guide/helm-specification) 解释了 Chart 格式,提供使用 Helm 构建 Chart 的基本指导。

Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ $ mkdir Wordpress

### 第三步:准备配置文件

其中 cluster.json.tmpl,config.json,package.json 这三个配置文件是必须的,详见 [开发模板规范](../openpitrix-specification)
其中 cluster.json.tmpl,config.json,package.json 这三个配置文件是必须的,详见 [开发模板规范](../developer-guide/openpitrix-specification)

**Wordpress/cluster.json.tmpl**

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ $ ls
cluster.json.tmpl config.json package.json
```

参见 [OpenPitrix 应用开发规范](../openpitrix-specification) 编辑 test 目录下文件,编辑好后保存。
参见 [OpenPitrix 应用开发规范](../developer-guide/openpitrix-specification) 编辑 test 目录下文件,编辑好后保存。

### 生成索引文件(可选)

Expand Down
8 changes: 4 additions & 4 deletions docs/v0.4/zh-CN/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: "常见问题"

1、作为新手,如何从一个最简单的例子入手?

我们提供了一个如何准备一个基于 OpenPitrix 应用开发规范的示例,建议从 [ WordPress 实战](../developer-guide/openpitrix-developer-guide/#wordpress-实战) 入手,从零开始准备一个配置包并上传到 OpenPitrix 中,后续可参考 [用户指南](../user-guide/introduction) 熟悉应用的全生命周期管理。
我们提供了一个如何准备一个基于 OpenPitrix 应用开发规范的示例,建议从 [WordPress 实战](../zh-CN/developer-guide/openpitrix-developer-guide/#wordpress-实战) 入手,从零开始准备一个配置包并上传到 OpenPitrix 中,后续可参考 [用户指南](../zh-CN/manual-guide/introduction) 熟悉应用的全生命周期管理。

2、应用如何语言国际化?

Expand All @@ -13,7 +13,7 @@ title: "常见问题"
- locale/en.json 英文翻译文件
- locale/zh-cn.json 中文翻译文件

具体配置请参考文档 [国际化](../developer-guide/openpitrix-specification/#国际化)
具体配置请参考文档 [国际化](../zh-CN/developer-guide/openpitrix-specification/#国际化)

3、上传配置包或新的版本时报错:配置验证失败,报 “创建资源失败” 错误?

Expand All @@ -23,11 +23,11 @@ title: "常见问题"

4、All-in-one 模式安装 OpenPitrix 时,卡在某一步进度一直没有变化,是什么原因?

可能是主机的配置规格不符合要求,比如内存不足,建议按照我们提供的 [all-in-one 模式 - 主机环境](../installation/allinone/#主机环境) 准备环境。
可能是主机的配置规格不符合要求,比如内存不足,建议按照我们提供的 [all-in-one 模式 - 主机环境](../zh-CN/installation/allinone/#主机环境) 准备环境。

5、All-in-one 模式安装 OpenPitrix 时,make 命令执行失败,为什么?

可能是依赖的软件版本不满足要求,可检查其版本并对照 [all-in-one 模式 - 软件环境](../installation/allinone/#软件环境) 安装符合要求的版本。
可能是依赖的软件版本不满足要求,可检查其版本并对照 [all-in-one 模式 - 软件环境](../zh-CN/installation/allinone/#软件环境) 安装符合要求的版本。

6、Kubernetes 模式执行安装脚本 deploy-k8s.sh 失败?

Expand Down
2 changes: 1 addition & 1 deletion docs/v0.4/zh-CN/getting-start/app-review.md
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ title: "应用审核与发布"

![](https://pek3b.qingstor.com/kubesphere-docs/png/20190618091028.png)

> 第一次部署由于需要从公网上下载必要的系统镜像,通常创建时间会比较长,应用部署成功后,这些镜像会缓存在 frontgate,以后再创建其它集群就从缓存中拉取系统镜像。若需要管理部署的集群如停用或删除集群,参考 [集群管理](../user-guide/cluster-management)
> 第一次部署由于需要从公网上下载必要的系统镜像,通常创建时间会比较长,应用部署成功后,这些镜像会缓存在 frontgate,以后再创建其它集群就从缓存中拉取系统镜像。若需要管理部署的集群如停用或删除集群,参考 [集群管理](../manual-guide/cluster-management)
## 审核应用 (Helm 版本)

Expand Down
2 changes: 1 addition & 1 deletion docs/v0.4/zh-CN/getting-start/regular-user-quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ title: "普通用户"
- 名称:aliyun-test-runtime
- 备注:阿里云测试环境

> 若准备将应用部署到 AWS 运行环境,参见 [部署 Wordpress 到 AWS](../user-guide/deploying-app-on-multicloud#部署应用至-aws)
> 若准备将应用部署到 AWS 运行环境,参见 [部署 Wordpress 到 AWS](../manual-guide/deploying-app-on-multicloud#部署应用至-aws)
### 第三步:部署实例

Expand Down
Loading

0 comments on commit a862cc6

Please sign in to comment.