Skip to content

Commit 8078e73

Browse files
committed
📃 docs: change commit user to public email
1 parent 4a52974 commit 8078e73

Some content is hidden

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

56 files changed

+1631
-73
lines changed

.github/workflows/lint.yml

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
name: MarkdownLint
2+
3+
on:
4+
push:
5+
branches:
6+
- master
7+
pull_request:
8+
branches:
9+
- master
10+
11+
jobs:
12+
linting:
13+
name: "Markdown linting"
14+
runs-on: ubuntu-latest
15+
16+
steps:
17+
- uses: actions/checkout@v2
18+
name: Check out the code
19+
- name: Lint Code Base
20+
uses: docker://avtodev/markdown-lint:v1
21+
with:
22+
args: "**/*.md"
23+
config: '.lint.yml'

.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
**/.vscode
12
assets/images/*.png
23

34
*.psd

.lint.yml

+140
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,140 @@
1+
default: false # includes/excludes all rules by default
2+
3+
# Heading levels should only increment by one level at a time <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md001>
4+
MD001: true
5+
6+
# Heading style <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md003>
7+
MD003: true
8+
9+
# Unordered list style <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md004>
10+
MD004: true
11+
12+
# Inconsistent indentation for list items at the same level <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md005>
13+
MD005: true
14+
15+
# Consider starting bulleted lists at the beginning of the line <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md006>
16+
MD006: true
17+
18+
# Unordered list indentation <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md007>
19+
MD007: true
20+
21+
# Trailing spaces <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md009>
22+
MD009: true
23+
24+
# Hard tabs <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md010>
25+
MD010: true
26+
27+
# Reversed link syntax <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md011>
28+
MD011: true
29+
30+
# Multiple consecutive blank lines <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md012>
31+
MD012: true
32+
33+
# Line length <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md013>
34+
MD013: false
35+
36+
# Dollar signs used before commands without showing output <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md014>
37+
MD014: false
38+
39+
# No space after hash on atx style heading <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md018>
40+
MD018: true
41+
42+
# Multiple spaces after hash on atx style heading <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md019>
43+
MD019: true
44+
45+
# No space inside hashes on closed atx style heading <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md020>
46+
MD020: true
47+
48+
# Multiple spaces inside hashes on closed atx style heading <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md021>
49+
MD021: true
50+
51+
# Headings should be surrounded by blank lines <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md022>
52+
MD022: true
53+
54+
# Headings must start at the beginning of the line <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md023>
55+
MD023: true
56+
57+
# Multiple headings with the same content <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md024>
58+
MD024:
59+
allow_different_nesting: true
60+
61+
# Multiple top level headings in the same document <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md025>
62+
MD025: true
63+
64+
# Trailing punctuation in heading <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md026>
65+
MD026: true
66+
67+
# Multiple spaces after blockquote symbol <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md027>
68+
MD027: true
69+
70+
# Blank line inside blockquote <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md028>
71+
MD028: false
72+
73+
# Ordered list item prefix <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md029>
74+
MD029: false
75+
76+
# Spaces after list markers <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md030>
77+
MD030: true
78+
79+
# Fenced code blocks should be surrounded by blank lines <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md031>
80+
MD031: true
81+
82+
# Lists should be surrounded by blank lines <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md032>
83+
MD032: true
84+
85+
# Inline HTML <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md033>
86+
MD033: true
87+
88+
# Bare URL used <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md034>
89+
MD034: true
90+
91+
# Horizontal rule style <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md035>
92+
MD035:
93+
style: '---'
94+
95+
# Emphasis used instead of a heading <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md036>
96+
MD036: true
97+
98+
# Spaces inside emphasis markers <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md037>
99+
MD037: true
100+
101+
# Spaces inside code span elements <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md038>
102+
MD038: true
103+
104+
# Spaces inside link text <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md039>
105+
MD039: true
106+
107+
# Fenced code blocks should have a language specified <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md040>
108+
MD040: true
109+
110+
# First line in file should be a top level heading <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md041>
111+
MD041: true
112+
113+
# No empty links <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md042>
114+
MD042: true
115+
116+
# Required heading structure <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md043>
117+
MD043: false
118+
119+
# Proper names should have the correct capitalization <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md044>
120+
MD044: false
121+
122+
# Images should have alternate text (alt text) <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md045>
123+
MD045: false
124+
125+
# Code block style <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md046>
126+
MD046:
127+
style: 'fenced'
128+
129+
# Files should end with a single newline character <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md047>
130+
MD047: true
131+
132+
# Code fence style <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md048>
133+
MD048:
134+
style: 'backtick'
135+
136+
# Custom rules:
137+
CHANGELOG-RULE-001: true
138+
CHANGELOG-RULE-002: true
139+
CHANGELOG-RULE-003: true
140+
CHANGELOG-RULE-004: true

README.md

+15-8
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,26 @@
1+
# 目录
12

2-
3-
## 目录
43
![Wechat](https://img.shields.io/badge/-colynnliu-%2307C160?style=flat&logo=Wechat&logoColor=white)
5-
[![Linkedin](https://img.shields.io/badge/-LinkedIn-%230A66C2?style=flat&logo=Linkedin&logoColor=white)](https://www.linkedin.com/in/colynn/)
64
[![Twitter](https://img.shields.io/badge/-Twitter-%231DA1F2?style=flat&logo=Twitter&logoColor=white)](https://twitter.com/colynnliu)
7-
<img src="https://visitor-badge.laobi.icu/badge?page_id=colynn.colynn" alt="visitor badge"/>
85

9-
### Jenkins 持续集成实战
6+
## Jenkins 持续集成实战
7+
108
* topic001: 如何定制镜像 [bilibili > 视频链接](https://www.bilibili.com/video/BV1zt4y1a7F1/)
119
* topic002: Jenkins + Kubernetes CI/CD 解决方案实战
12-
* jenkins kubernetes ci/cd避免踩坑 - 实践注意项 - 第2篇 [bilibili > 视频链接](https://www.bilibili.com/video/BV1A5411V7zm/)
13-
* jenkins kubernetes ci/cd避免踩坑 - 实践注意项 - 第3篇 [bilibili > 视频链接](https://www.bilibili.com/video/BV1G5411V7mU/)
10+
* jenkins kubernetes ci/cd避免踩坑 - 实践注意项 - 第2篇 [bilibili > 视频链接](https://www.bilibili.com/video/BV1A5411V7zm/)
11+
* jenkins kubernetes ci/cd避免踩坑 - 实践注意项 - 第3篇 [bilibili > 视频链接](https://www.bilibili.com/video/BV1G5411V7mU/)
1412
* topic003: 如何写好 Jenkinsfile/Pipeline [bilibili > 视频链接](https://www.bilibili.com/video/BV1ph411W7Ek/)
1513
* topic004: 基于[workflow](https://github.com/go-atomci/workflow) 实现 Jenkins自定义Pipeline [bilibili > 视频链接](https://www.bilibili.com/video/BV1zb4y127EQ)
1614
* topic005: 分享基于云原生理念的 cicd平台-atomci 如何安装部署 [bilibili > 视频链接](https://www.bilibili.com/video/BV1qq4y1N7mZ/)
1715
* topic006: AtomCI 云原生的devops平台真得这么香吗 [bilibili > 视频链接](https://www.bilibili.com/video/BV1K3411m78Q/)
16+
* topic007: AtomCI 云原生的devops平台 - 5分钟全流程体验 [bilibili > 视频链接](https://www.bilibili.com/video/BV18F411a7Rk/)
17+
18+
## Golang Tips
19+
20+
## Dockerfile
1821

19-
### Golang Tips
22+
* 专题1: 如何写好dockerfile- 什么是docker [bilibili > 视频链接](https://www.bilibili.com/video/BV1sq4y117E8/)
23+
* 专题2: 如何写好dockerfile- 什么是dockerfile [bilibili > 视频链接](https://www.bilibili.com/video/BV1ri4y1X7WU/)
24+
* 专题3: 如何写好dockerfile- dockerfile结构、语法 [bilibili > 视频链接](https://www.bilibili.com/video/BV1UY411a7tK/)
25+
* 专题4: 如何写好dockerfile- dockerfile常用命令FROM/RUN [bilibili > 视频链接](https://www.bilibili.com/video/BV1wL411c7gn/)
26+
* 专题5:如何写好dockerfile- dockerfile常用命令WORKDIR/COPY/ADD [bilibili > 视频链接](https://www.bilibili.com/video/BV1PY411b7xC/)

argo/README.md

+51
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
# argo workflow
2+
3+
## Argo Workflow Overview
4+
5+
![image](./assets/overview.jpeg)
6+
7+
## Argo Core Concepts
8+
9+
* **Workflow**: a Kubernetes resource defining the execution of one or more **template**. Workflows are named.
10+
11+
* **Template**: a **step**, **steps** or **dag**.
12+
13+
* **Step**: a single step of a **workflow**, typically run a container based on **inputs** and capture the **outputs**.
14+
15+
* **Inputs**: **parameters** and **artifacts** passed to the **step**,
16+
* **Outputs**: **parameters** and **artifacts** outputted by a **step**
17+
18+
* **Parameters**: objects, strings, booleans, arrays
19+
20+
* **Artifacts**: files saved by a container
21+
* **Artifact Repository**: a place where **artifacts** are stored
22+
23+
* **Executor**: the method to execute a container, e.g. Docker, PNS ([learn more](workflow-executors.md))
24+
25+
## Multiple Events Sources/ Trigger
26+
27+
![IMage](./assets/argo-workflow-trigger.png)
28+
29+
## Workflow Notifications
30+
31+
There are a number of use cases where you may wish to notify an external system when a workflow completes:
32+
33+
1. Send an email.
34+
2. Send a Slack (or other instant message).
35+
3. Send a message to Kafka (or other message bus).
36+
37+
You have options:
38+
39+
1. For individual workflows, can add an exit handler to your workflow, [for example](https://raw.githubusercontent.com/argoproj/argo-workflows/master/examples/exit-handlers.yaml).
40+
1. If you want the same for every workflow, you can add an exit handler to [the default workflow spec](default-workflow-specs.md).
41+
1. Use a service (e.g. [Heptio Labs EventRouter](https://github.com/heptiolabs/eventrouter)) to the [Workflow events](workflow-events.md) we emit.
42+
43+
## Argo OpenAPI
44+
45+
![image](./assets/swagger-snapshot.png)
46+
47+
详情[argo openapi-spec](https://github.com/argoproj/argo-workflows/blob/master/api/openapi-spec/swagger.json)
48+
49+
## Argo Mertics
50+
51+
![image](assets/argo-workflow-mertic.png)

argo/assets/argo-workflow-mertic.png

2.24 MB
Loading

argo/assets/argo-workflow-trigger.png

180 KB
Loading

argo/assets/overview.jpeg

57.6 KB
Loading

argo/assets/swagger-snapshot.png

166 KB
Loading

assets/images/iTerm2-background.jpg

1.75 MB
Loading

devops/01.hello-vueproject.md

+6-5
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,23 @@
11
# How to create Vue Project
22

33
## 前置条件
4+
45
* `npm`or`yarn` installed
56

6-
## Env
7+
## Env
8+
79
* Ubuntu 16.04
810

911
## Install vue cli
1012

1113
```sh
12-
$ yarn global add @vue/cli
14+
yarn global add @vue/cli
1315
```
14-
____: 安装的`vue``/usr/local/bin/`下, 确认下普通用户是否有相关链接的权限,没有的话,添加下即可正常使用`vue`
1516

17+
____: 安装的`vue``/usr/local/bin/`下, 确认下普通用户是否有相关链接的权限,没有的话,添加下即可正常使用`vue`
1618

1719
## Create new project
1820

1921
```sh
20-
$ vue create nodejs-app-demo
22+
vue create nodejs-app-demo
2123
```
22-

docker/README.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
2+
# Docker Docs
3+
4+
## outline
5+
6+
* [x] [dockerfile 使用介绍](https://github.com/warm-native/docs/blob/master/docker/dockerfile-guide.md)
7+

0 commit comments

Comments
 (0)