Skip to content

Commit 153ba73

Browse files
committed
chore: use idoc build website.
1 parent 8209cac commit 153ba73

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

44 files changed

+327
-159
lines changed

.github/workflows/ci.yml

Lines changed: 51 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: build
1+
name: CI
22
on:
33
push:
44
branches:
@@ -8,33 +8,59 @@ jobs:
88
build:
99
runs-on: ubuntu-18.04
1010
steps:
11-
- uses: actions/checkout@v2
12-
- uses: actions/setup-node@v2
11+
- uses: actions/checkout@v3
12+
- uses: actions/setup-node@v3
1313
with:
14-
node-version: 14
15-
16-
- run: mkdir -p build
17-
- run: cp -rp img build
18-
- run: npm i markdown-to-html-cli -g
19-
- run: markdown-to-html --output build/index.html
20-
- run: markdown-to-html -s docker/sourcegraph.md --output build/sourcegraph.html
21-
- run: markdown-to-html -s docker/rocket.chat/README.md --output build/rocket.chat.html
22-
- run: markdown-to-html -s docker/docker-compose.md --output build/docker-compose.html
23-
- run: markdown-to-html -s docker/elasticsearch.md --output build/elasticsearch.html
24-
- run: markdown-to-html -s docker/gitlab.md --output build/gitlab.html
25-
- run: markdown-to-html -s docker/harbor.md --output build/harbor.html
26-
- run: markdown-to-html -s docker/mattermost.md --output build/mattermost.html
27-
- run: markdown-to-html -s docker/mysql.md --output build/mysql.html
28-
- run: markdown-to-html -s docker/nginx.md --output build/nginx.html
29-
- run: markdown-to-html -s docker/nps.md --output build/nps.html
30-
- run: markdown-to-html -s docker/portainer.md --output build/portainer.html
31-
- run: markdown-to-html -s docker/postgres.md --output build/postgres.html
32-
- run: markdown-to-html -s docker/rancher.md --output build/rancher.html
33-
- run: markdown-to-html -s docker/redis.md --output build/redis.html
34-
- run: markdown-to-html -s docker/seaweedfs/README.md --output build/seaweedfs.html
14+
node-version: 16
15+
16+
- run: npm install
17+
- run: npm run build
3518

3619
- name: Deploy
3720
uses: peaceiris/actions-gh-pages@v3
3821
with:
3922
github_token: ${{ secrets.GITHUB_TOKEN }}
40-
publish_dir: ./build
23+
publish_dir: ./dist
24+
25+
- name: Generate Contributors Images
26+
uses: jaywcjlove/github-action-contributors@main
27+
with:
28+
filter-author: (renovate\[bot\]|renovate-bot|dependabot\[bot\])
29+
output: dist/CONTRIBUTORS.svg
30+
avatarSize: 42
31+
32+
- name: Create Tag
33+
id: create_tag
34+
uses: jaywcjlove/[email protected]
35+
with:
36+
package-path: ./package.json
37+
38+
- name: Deploy Website
39+
uses: peaceiris/actions-gh-pages@v3
40+
with:
41+
user_name: 'github-actions[bot]'
42+
user_email: 'github-actions[bot]@users.noreply.github.com'
43+
commit_message: ${{steps.tag_version.outputs.tag}} ${{ github.event.head_commit.message }}
44+
github_token: ${{ secrets.GITHUB_TOKEN }}
45+
publish_dir: ./dist
46+
47+
- name: Generate Changelog
48+
id: changelog
49+
uses: jaywcjlove/[email protected]
50+
with:
51+
token: ${{ secrets.GITHUB_TOKEN }}
52+
filter-author: (jaywcjlove|小弟调调™|dependabot\[bot\]|Renovate Bot)
53+
filter: (^[\s]+?[R|r]elease)|(^[R|r]elease)
54+
55+
- name: Create Release
56+
uses: ncipollo/release-action@v1
57+
if: steps.create_tag.outputs.successful
58+
with:
59+
token: ${{ secrets.GITHUB_TOKEN }}
60+
name: ${{ steps.create_tag.outputs.version }}
61+
tag: ${{ steps.create_tag.outputs.version }}
62+
body: |
63+
Documentation ${{ steps.changelog.outputs.tag }}: https://raw.githack.com/jaywcjlove/vim-web/${{ steps.changelog.outputs.gh-pages-short-hash }}/index.html
64+
Comparing Changes: ${{ steps.changelog.outputs.compareurl }}
65+
66+
${{ steps.changelog.outputs.changelog }}

.gitignore

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,26 @@
1+
dist
2+
node_modules
3+
test/out
4+
5+
npm-debug.log*
6+
lerna-debug.log
7+
yarn-error.log
8+
package-lock.json
9+
110
.DS_Store
11+
.cache
12+
.vscode
13+
.idea
14+
15+
*.bak
16+
*.tem
17+
*.temp
18+
#.swp
19+
*.*~
20+
~*.*
21+
22+
# IDEA
23+
*.iml
24+
*.ipr
25+
*.iws
26+
.idea/

README.md

Lines changed: 37 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11

2-
<p align="center">
3-
<img width="130" align="center" src="img/logo.svg"/>
4-
</p>
5-
<h1 align="center">Docker入门教程</h1>
6-
72

3+
<!--idoc:ignore:start-->
4+
<h1 align="center">Docker入门教程</h1>
5+
<!--idoc:ignore:end-->
86

9-
Docker 是一个开源的应用容器引擎,而一个<ruby>容器<rt>containers</rt></ruby>其实是一个虚拟化的独立的环境,让开发者可以打包他们的应用以及依赖包到一个可移植的容器中,然后发布到任何流行的 Linux 机器上,也可以实现虚拟化。容器是完全使用沙箱机制,相互之间不会有任何接口。
7+
[Docker](https://www.docker.com/) 是一个开源的应用容器引擎,而一个<ruby>容器<rt>containers</rt></ruby>其实是一个虚拟化的独立的环境,让开发者可以打包他们的应用以及依赖包到一个可移植的容器中,然后发布到任何流行的 Linux 机器上,也可以实现虚拟化。容器是完全使用沙箱机制,相互之间不会有任何接口。
108

119
- Docker 的局限性之一,它只能用在 64 位的操作系统上。
1210

11+
<!--idoc:ignore:start-->
12+
1313
目录
1414
===
1515

@@ -56,6 +56,7 @@ Docker 是一个开源的应用容器引擎,而一个<ruby>容器<rt>container
5656
- [其它资源](#其它资源)
5757

5858
<!-- /TOC -->
59+
<!--idoc:ignore:end-->
5960

6061
Docker 从 `1.13` 版本之后采用时间线的方式作为版本号,分为社区版 `CE` 和企业版 `EE`,社区版是免费提供给个人开发者和小型团体使用的,企业版会提供额外的收费服务,比如经过官方测试认证过的基础设施、容器、插件等。
6162

@@ -511,7 +512,7 @@ docker container stop registry && docker container rm -v registry
511512

512513
### `Harbor`
513514

514-
[部署 registry 管理工具 Harbor](docker/harbor.md)
515+
[部署 registry 管理工具 Harbor](docs/harbor.md)
515516

516517
## Docker REST API
517518

@@ -627,55 +628,55 @@ docker info
627628

628629
### `Nginx`
629630

630-
[在 docker 中部署 Nginx](docker/nginx.md)
631+
[在 docker 中部署 Nginx](docs/nginx.md)
631632

632633
### `MySQL`
633634

634-
[在 docker 中部署 MySQL](docker/mysql.md)
635+
[在 docker 中部署 MySQL](docs/mysql.md)
635636

636637
### `PostgreSQL`
637638

638-
[在 docker 中部署 PostgreSQL](docker/postgres.md)
639+
[在 docker 中部署 PostgreSQL](docs/postgres.md)
639640

640641
### `Redis`
641642

642-
[在 docker 中部署 Redis](docker/redis.md)
643+
[在 docker 中部署 Redis](docs/redis.md)
643644

644645
### `Elasticsearch`
645646

646-
[在 docker 中部署 Elasticsearch](docker/elasticsearch.md)
647+
[在 docker 中部署 Elasticsearch](docs/elasticsearch.md)
647648

648649
### `Gitlab`
649650

650-
[在 docker 中部署 Gitlab](docker/gitlab.md)
651+
[在 docker 中部署 Gitlab](docs/gitlab/README.md)
651652

652653
### `Rocket.Chat`
653654

654-
[在 docker 中部署 Gitlab](docker/rocket.chat/README.md)
655+
[在 docker 中部署 Gitlab](docs/rocket.chat/README.md)
655656

656657
### `Rancher`
657658

658-
[在 docker 中部署 Rancher](docker/rancher.md)
659+
[在 docker 中部署 Rancher](docs/rancher.md)
659660

660661
### `Portainer`
661662

662-
[在 docker 中部署 Portainer](docker/portainer.md)
663+
[在 docker 中部署 Portainer](docs/portainer.md)
663664

664665
### `Sourcegraph`
665666

666-
[在 docker 中部署 Sourcegraph](docker/sourcegraph.md)
667+
[在 docker 中部署 Sourcegraph](docs/sourcegraph/README.md)
667668

668669
### `Mattermost`
669670

670-
[在 docker 中部署 Mattermost](docker/mattermost.md)
671+
[在 docker 中部署 Mattermost](docs/mattermost.md)
671672

672673
### `SeaweedFS`
673674

674-
[在 docker 中部署 SeaweedFS](docker/seaweedfs/README.md)
675+
[在 docker 中部署 SeaweedFS](docs/seaweedfs/README.md)
675676

676677
### `NPS`
677678

678-
[在 docker 中搭建内网穿透服务器,带WEB管理](docker/nps.md)
679+
[在 docker 中搭建内网穿透服务器,带WEB管理](docs/nps/README.md)
679680

680681
### `Humpback`
681682

@@ -718,7 +719,7 @@ docker run -d --name seafile \
718719

719720
### 更多
720721

721-
[更多 docker 工具部署,在 docker 目录中](docker/)
722+
[更多 docker 工具部署,在 docker 目录中](docs/)
722723

723724
## 卸载旧的版本
724725

@@ -792,4 +793,18 @@ Create more free space in thin pool or use dm.min_free_space option to change be
792793
- https://segmentfault.com/t/docker
793794
- https://github.com/docker/docker
794795
- https://wiki.openstack.org/wiki/Docker
795-
- https://wiki.archlinux.org/index.php/Docker
796+
- https://wiki.archlinux.org/index.php/Docker
797+
798+
## Contributors
799+
800+
As always, thanks to our amazing contributors!
801+
802+
<a href="https://github.com/jaywcjlove/docker-tutorial/graphs/contributors">
803+
<img src="https://jaywcjlove.github.io/docker-tutorial/CONTRIBUTORS.svg" />
804+
</a>
805+
806+
Made with [action-contributors](https://github.com/jaywcjlove/github-action-contributors).
807+
808+
## License
809+
810+
Licensed under the MIT License.

docker/rocket.chat/README.md

Lines changed: 0 additions & 25 deletions
This file was deleted.

docker/docker-compose.md renamed to docs/docker-compose.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
Docker Compose
22
===
33

4+
![](./logo.png)
45

56
`docker-compose` 是用来做 `docker` 的多容器控制,这个工具是用于 docker 自动化的东西,将多个 docker 容器的操作命令,简化成一条命令,自动完成配置中的容器启动。
67

@@ -22,7 +23,6 @@ docker-compose --version
2223
## 服务运行
2324

2425
```bash
25-
2626
# 停止当前服务
2727
docker-compose -p intelligent-community-dev -f docker-compose.dev.yml down
2828
# 使用 docker-compose 后台启动服务
File renamed without changes.

docs/gitlab/001.png

198 KB
Loading

docs/gitlab/002.png

203 KB
Loading

docker/gitlab.md renamed to docs/gitlab/README.md

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -57,8 +57,8 @@ iptables -L -n
5757
docker exec -it gitlab update-permissions
5858
docker restart gitlab
5959
```
60-
## 容器手动备份
6160

61+
## 容器手动备份
6262

6363
```bash
6464
# 第一种进行入容器执行命令的方法进行手工备份
@@ -127,7 +127,7 @@ gitlab_rails['backup_keep_time'] = 604800
127127
docker exec 容器名或容器ID gitlab-ctl reconfigure
128128
```
129129

130-
### 容器管理
130+
## 容器管理
131131

132132
```bash
133133
docker stop gitlab # 停止容器
@@ -139,7 +139,7 @@ docker exec -it gitlab vim /etc/gitlab/gitlab.rb
139139
docker restart gitlab
140140
```
141141

142-
### 通过 Docker Compose 按照
142+
## 通过 Docker Compose 安装
143143

144144
使用 Docker Compose,可以轻松配置,安装和升级基于 Docker 的 GitLab 安装,[官方教程在这里](https://docs.gitlab.com/omnibus/docker/README.html#install-gitlab-using-docker-compose)
145145

@@ -173,7 +173,7 @@ web:
173173
**第三步:** 确保与 `docker-compose.yml` 文件同一目录下运行 `docker-compose up -d` 启动 Gitlab
174174

175175

176-
### 使用 Docker Swarm
176+
## 使用 Docker Swarm
177177

178178
[官方教程](https://docs.gitlab.com/omnibus/docker/README.html#deploy-gitlab-in-a-docker-swarm) 创建 `docker-compose.yml` 文件
179179

@@ -234,7 +234,9 @@ MySuperSecretAndSecurePass0rd!
234234
docker stack deploy --compose-file docker-compose.yml gitlab
235235
```
236236

237-
## [`注册 runner`](https://docs.gitlab.com/runner/install/docker.html)
237+
## 注册 Runner
238+
239+
官方 [`注册 runner`](https://docs.gitlab.com/runner/install/docker.html) 文档
238240

239241
### 更新配置
240242

@@ -334,11 +336,11 @@ ERROR: error during connect: Get http://docker:2375/v1.40/info: dial tcp: lookup
334336

335337
工作被卡住了,因为你的 runner 有标签,但你的 job 没有。 按照以下 4 个步骤,让您的 runner 在没有标签的情况下运行:
336338

337-
![Gitlab runner](https://user-images.githubusercontent.com/1680273/150721733-d4fb90b8-29e4-44bf-b238-9d88ac01b5bd.png)
339+
![Gitlab runner](./001.png)
338340

339-
![Gitlab runner](https://user-images.githubusercontent.com/1680273/150721878-24f6b6f6-a476-4f7e-a0da-092ea4771ecb.png)
341+
![Gitlab runner](./002.png)
340342

341-
### CI 中使用编译提交镜像
343+
## CI 中使用编译提交镜像
342344

343345
下面是 [官方仓库 Docker.gitlab-ci.yml](https://gitlab.com/gitlab-org/gitlab/-/blob/master/lib/gitlab/ci/templates/Docker.gitlab-ci.yml) 模板
344346

@@ -382,7 +384,7 @@ docker-build:
382384
- master
383385
```
384386

385-
### 错误处理
387+
## 错误处理
386388

387389
```bash
388390
gitlab ci ERROR: Uploading artifacts to coordinator... too large archive
@@ -394,7 +396,7 @@ gitlab ci ERROR: Uploading artifacts to coordinator... too large archive
394396
client_max_body_size 10m;
395397
```
396398

397-
### 升级
399+
## 升级
398400

399401
目标版本 | 你的版本 | 支持升级 | 路径 | 注意
400402
---- | ---- | ---- | ---- | ----
File renamed without changes.

0 commit comments

Comments
 (0)