Skip to content

Commit a279574

Browse files
authored
seatunnel offical website init (apache#2)
* seatunnel website init * seatunnel website init
1 parent c2ad169 commit a279574

File tree

186 files changed

+17552
-0
lines changed

Some content is hidden

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

186 files changed

+17552
-0
lines changed

.asf.yaml

+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# Licensed to the Apache Software Foundation (ASF) under one or more
2+
# contributor license agreements. See the NOTICE file distributed with
3+
# this work for additional information regarding copyright ownership.
4+
# The ASF licenses this file to You under the Apache License, Version 2.0
5+
# (the "License"); you may not use this file except in compliance with
6+
# the License. You may obtain a copy of the License at
7+
#
8+
# http://www.apache.org/licenses/LICENSE-2.0
9+
#
10+
# Unless required by applicable law or agreed to in writing, software
11+
# distributed under the License is distributed on an "AS IS" BASIS,
12+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
# See the License for the specific language governing permissions and
14+
# limitations under the License.
15+
#
16+
17+
github:
18+
features:
19+
# Enable issue management
20+
issues: true
21+
description: Apache SeaTunnel documents
22+
homepage: https://seatunnel.apache.org/
23+
labels:
24+
- seatunnel
25+
- website
26+
27+
# If this branch is asf-staging, it will be published to https://seatunnel.staged.apache.org/
28+
staging:
29+
profile: ~
30+
whoami: asf-staging
31+
32+
# asf-site branch will show up at https://seatunnel.apache.org
33+
publish:
34+
whoami: asf-site

.github/workflows/deploy.yml

+40
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
name: Build and Deploy
2+
3+
on:
4+
pull_request:
5+
branches: [dev]
6+
push:
7+
branches: [dev]
8+
schedule:
9+
# Run everyday at 9:00 AM (See https://pubs.opengroup.org/onlinepubs/9699919799/utilities/crontab.html#tag_20_25_07)
10+
- cron: "0 5 * * *"
11+
12+
# A workflow run is made up of one or more jobs that can run sequentially or in parallel
13+
jobs:
14+
# This workflow contains a single job called "build"
15+
build:
16+
# The type of runner that the job will run on
17+
runs-on: ubuntu-latest
18+
19+
# Steps represent a sequence of tasks that will be executed as part of the job
20+
steps:
21+
# Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
22+
- uses: actions/[email protected]
23+
- uses: actions/[email protected]
24+
with:
25+
node-version: 14
26+
27+
- name: install
28+
run: |
29+
npm install
30+
- name: Build
31+
run: |
32+
npm run build
33+
cp .asf.yaml build
34+
- name: Deploy
35+
uses: peaceiris/[email protected]
36+
if: github.event_name == 'push' && github.ref == 'refs/heads/dev'
37+
with:
38+
github_token: ${{ secrets.GITHUB_TOKEN }}
39+
publish_dir: build
40+
publish_branch: asf-staging

.gitignore

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Intellij
2+
.idea/
3+
*.iml
4+
*.iws
5+
6+
# Dependencies
7+
/node_modules
8+
9+
# Production
10+
/build
11+
12+
# Generated files
13+
.docusaurus
14+
.cache-loader
15+
16+
.DS_Store
17+
dist
18+
dist-ssr
19+
*.local
20+
*.idea
21+
*.iml.
22+
.vscode
23+
/package-lock.json

Logo.png

-137 KB
Binary file not shown.

README.md

+41
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# Website
2+
3+
This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
4+
5+
### Installation
6+
7+
```
8+
$ yarn
9+
```
10+
11+
### Local Development
12+
13+
```
14+
$ yarn start
15+
```
16+
17+
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
18+
19+
### Build
20+
21+
```
22+
$ yarn build
23+
```
24+
25+
This command generates static content into the `build` directory and can be served using any static contents hosting service.
26+
27+
### Deployment
28+
29+
Using SSH:
30+
31+
```
32+
$ USE_SSH=true yarn deploy
33+
```
34+
35+
Not using SSH:
36+
37+
```
38+
$ GIT_USER=<Your GitHub username> yarn deploy
39+
```
40+
41+
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.

babel.config.js

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
module.exports = {
2+
presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
3+
};

blog/2019-05-28-first-blog-post.md

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
slug: first-blog-post
3+
title: First Blog Post
4+
authors:
5+
name: Gao Wei
6+
title: Docusaurus Core Team
7+
url: https://github.com/wgao19
8+
image_url: https://github.com/wgao19.png
9+
tags: [hola, docusaurus]
10+
---
11+
12+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet

blog/2019-05-29-long-blog-post.md

+44
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
---
2+
slug: long-blog-post
3+
title: Long Blog Post
4+
authors: endi
5+
tags: [hello, docusaurus]
6+
---
7+
8+
This is the summary of a very long blog post,
9+
10+
Use a `<!--` `truncate` `-->` comment to limit blog post size in the list view.
11+
12+
<!--truncate-->
13+
14+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
15+
16+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
17+
18+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
19+
20+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
21+
22+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
23+
24+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
25+
26+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
27+
28+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
29+
30+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
31+
32+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
33+
34+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
35+
36+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
37+
38+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
39+
40+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
41+
42+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
43+
44+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet

blog/2021-08-01-mdx-blog-post.mdx

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
slug: mdx-blog-post
3+
title: MDX Blog Post
4+
authors: [slorber]
5+
tags: [docusaurus]
6+
---
7+
8+
Blog posts support [Docusaurus Markdown features](https://docusaurus.io/docs/markdown-features), such as [MDX](https://mdxjs.com/).
9+
10+
:::tip
11+
12+
Use the power of React to create interactive blog posts.
13+
14+
```js
15+
<button onClick={() => alert('button clicked!')}>Click me!</button>
16+
```
17+
18+
<button onClick={() => alert('button clicked!')}>Click me!</button>
19+
20+
:::
Loading

blog/2021-08-26-welcome/index.md

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
slug: welcome
3+
title: Welcome
4+
authors: [slorber, yangshun]
5+
tags: [facebook, hello, docusaurus]
6+
---
7+
8+
[Docusaurus blogging features](https://docusaurus.io/docs/blog) are powered by the [blog plugin](https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-content-blog).
9+
10+
Simply add Markdown files (or folders) to the `blog` directory.
11+
12+
Regular blog authors can be added to `authors.yml`.
13+
14+
The blog post date can be extracted from filenames, such as:
15+
16+
- `2019-05-30-welcome.md`
17+
- `2019-05-30-welcome/index.md`
18+
19+
A blog post folder can be convenient to co-locate blog post images:
20+
21+
![Docusaurus Plushie](./docusaurus-plushie-banner.jpeg)
22+
23+
The blog supports tags as well!
24+
25+
**And if you don't want a blog**: just delete this directory, and use `blog: false` in your Docusaurus config.

blog/authors.yml

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
endi:
2+
name: Endilie Yacop Sucipto
3+
title: Maintainer of Docusaurus
4+
url: https://github.com/endiliey
5+
image_url: https://github.com/endiliey.png
6+
7+
yangshun:
8+
name: Yangshun Tay
9+
title: Front End Engineer @ Facebook
10+
url: https://github.com/yangshun
11+
image_url: https://github.com/yangshun.png
12+
13+
slorber:
14+
name: Sébastien Lorber
15+
title: Docusaurus maintainer
16+
url: https://sebastienlorber.com
17+
image_url: https://github.com/slorber.png

docs/configuration/_category_.json

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"label": "配置",
3+
"position": 3
4+
}

docs/configuration/base.md

+114
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,114 @@
1+
# 通用配置
2+
3+
## 核心概念
4+
5+
* Row 是seatunnel逻辑意义上一条数据,是数据处理的基本单位。在Filter处理数据时,所有的数据都会被映射为Row。
6+
7+
* Field 是Row的一个字段。Row可以包含嵌套层级的字段。
8+
9+
* raw_message 指的是从input输入的数据在Row中的`raw_message`字段。
10+
11+
* __root__ 指的是Row的最顶级的字段相同的字段层级,常用于指定数据处理过程中生成的新字段在Row中的存储位置(top level field)。
12+
13+
14+
---
15+
16+
## 配置文件
17+
18+
一个完整的seatunnel配置包含`spark`, `input`, `filter`, `output`, 即:
19+
20+
```
21+
spark {
22+
...
23+
}
24+
25+
input {
26+
...
27+
}
28+
29+
filter {
30+
...
31+
}
32+
33+
output {
34+
...
35+
}
36+
37+
```
38+
39+
* `spark`是spark相关的配置,
40+
41+
可配置的spark参数见:
42+
[Spark Configuration](https://spark.apache.org/docs/latest/configuration.html#available-properties),
43+
其中master, deploy-mode两个参数不能在这里配置,需要在seatunnel启动脚本中指定。
44+
45+
* `input`可配置任意的input插件及其参数,具体参数随不同的input插件而变化。
46+
47+
* `filter`可配置任意的filter插件及其参数,具体参数随不同的filter插件而变化。
48+
49+
filter中的多个插件按配置顺序形成了数据处理的pipeline, 上一个filter的输出是下一个filter的输入。
50+
51+
* `output`可配置任意的output插件及其参数,具体参数随不同的output插件而变化。
52+
53+
`filter`处理完的数据,会发送给`output`中配置的每个插件。
54+
55+
56+
---
57+
58+
## 配置文件示例
59+
60+
一个示例如下:
61+
62+
> 配置中, 以`#`开头的行为注释。
63+
64+
```
65+
spark {
66+
# You can set spark configuration here
67+
# seatunnel defined streaming batch duration in seconds
68+
spark.streaming.batchDuration = 5
69+
70+
# see available properties defined by spark: https://spark.apache.org/docs/latest/configuration.html#available-properties
71+
spark.app.name = "seatunnel"
72+
spark.executor.instances = 2
73+
spark.executor.cores = 1
74+
spark.executor.memory = "1g"
75+
}
76+
77+
input {
78+
# This is a example input plugin **only for test and demonstrate the feature input plugin**
79+
fakestream {
80+
content = ["Hello World, InterestingLab"]
81+
rate = 1
82+
}
83+
84+
85+
# If you would like to get more information about how to configure seatunnel and see full list of input plugins,
86+
# please go to https://interestinglab.github.io/seatunnel-docs/#/zh-cn/v1/configuration/base
87+
}
88+
89+
filter {
90+
split {
91+
fields = ["msg", "name"]
92+
delimiter = ","
93+
}
94+
95+
# If you would like to get more information about how to configure seatunnel and see full list of filter plugins,
96+
# please go to https://interestinglab.github.io/seatunnel-docs/#/zh-cn/v1/configuration/base
97+
}
98+
99+
output {
100+
stdout {}
101+
102+
103+
# If you would like to get more information about how to configure seatunnel and see full list of output plugins,
104+
# please go to https://interestinglab.github.io/seatunnel-docs/#/zh-cn/v1/configuration/base
105+
}
106+
```
107+
108+
其他配置可参考:
109+
110+
[配置示例1 : Streaming 流式计算](https://github.com/InterestingLab/seatunnel/blob/master/config/streaming.conf.template)
111+
112+
[配置示例2 : Batch 离线批处理](https://github.com/InterestingLab/seatunnel/blob/master/config/batch.conf.template)
113+
114+
[配置示例3 : 一个灵活的多数据流程处理](https://github.com/InterestingLab/seatunnel/blob/master/config/complex.conf.template)

0 commit comments

Comments
 (0)