You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@seatunnel.apache.org by GitBox <gi...@apache.org> on 2022/04/25 08:19:47 UTC
[GitHub] [incubator-seatunnel] BenJFan opened a new pull request, #1740: [Feature][Doc] Add Config file introduce.
BenJFan opened a new pull request, #1740:
URL: https://github.com/apache/incubator-seatunnel/pull/1740
<!--
Thank you for contributing to SeaTunnel! Please make sure that your code changes
are covered with tests. And in case of new features or big changes
remember to adjust the documentation.
Feel free to ping committers for the review!
## Contribution Checklist
- Make sure that the pull request corresponds to a [GITHUB issue](https://github.com/apache/incubator-seatunnel/issues).
- Name the pull request in the form "[Feature] [component] Title of the pull request", where *Feature* can be replaced by `Hotfix`, `Bug`, etc.
- Minor fixes should be named following this pattern: `[hotfix] [docs] Fix typo in README.md doc`.
-->
## Purpose of this pull request
Add Config file introduce.
<!-- Describe the purpose of this pull request. For example: This pull request adds checkstyle plugin.-->
## Check list
* [ ] Code changed are covered with tests, or it does not need tests for reason:
* [ ] If any new Jar binary package adding in your PR, please add License Notice according
[New License Guide](https://github.com/apache/incubator-seatunnel/blob/dev/docs/en/contribution/new-license.md)
* [ ] If necessary, please update the documentation to describe the new feature. https://github.com/apache/incubator-seatunnel/tree/dev/docs
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@seatunnel.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-seatunnel] BenJFan commented on a diff in pull request #1740: [Feature][Doc] Add Config file introduce.
Posted by GitBox <gi...@apache.org>.
BenJFan commented on code in PR #1740:
URL: https://github.com/apache/incubator-seatunnel/pull/1740#discussion_r859414916
##########
docs/en/start/config.md:
##########
@@ -0,0 +1,108 @@
+---
+sidebar_position: 5
+---
+
+# Intro to config file
Review Comment:
You are right, maybe add a new parent sidebar will be more suitable.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@seatunnel.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-seatunnel] zhongjiajie commented on a diff in pull request #1740: [Feature][Doc] Add Config file introduce.
Posted by GitBox <gi...@apache.org>.
zhongjiajie commented on code in PR #1740:
URL: https://github.com/apache/incubator-seatunnel/pull/1740#discussion_r859343626
##########
docs/en/faq.md:
##########
@@ -1,11 +1,8 @@
# FAQ
-why-i-should-install-computing-engine-like-spark-or-flink
-
## Why I should install computing engine like Spark or Flink
-<!-- We should add the reason -->
-TODO
+Now SeaTunnel uses computing engines like spark and flink to complete resource scheduling and node communication, so we can focus on the ease of use of data synchronization and the development of high-performance components. But this is only temporary.
Review Comment:
```suggestion
Now SeaTunnel uses computing engines such as spark and flink to complete resource scheduling and node communication, so we can focus on the ease of use of data synchronization and the development of high-performance components. But this is only temporary.
```
##########
docs/en/start/config.md:
##########
@@ -0,0 +1,108 @@
+---
+sidebar_position: 5
+---
+
+# Intro to config file
Review Comment:
I do not think we should put `config.md` in the start section. This will make our structure not clear, because both local, docker, and k8s are the way to bring ST up, but config is for all kind of deployment. I personally prefer to add a new parent sidebar named `how to` or `concept` to put some "usage" or "common" docs like that. WDYT?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@seatunnel.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-seatunnel] BenJFan commented on pull request #1740: [Feature][Doc] Add Config file introduce.
Posted by GitBox <gi...@apache.org>.
BenJFan commented on PR #1740:
URL: https://github.com/apache/incubator-seatunnel/pull/1740#issuecomment-1112822516
> LGTM, thanks @BenJFan . BTW, I change the sidebar position between `Quick Start` and `Concept`. Because I think the concept is based on users could start and run our first job, it is an advanced topic for users. So it should after quick start
Thanks for help.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@seatunnel.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-seatunnel] zhongjiajie merged pull request #1740: [Feature][Doc] Add Config file introduce.
Posted by GitBox <gi...@apache.org>.
zhongjiajie merged PR #1740:
URL: https://github.com/apache/incubator-seatunnel/pull/1740
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@seatunnel.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-seatunnel] zhongjiajie commented on a diff in pull request #1740: [Feature][Doc] Add Config file introduce.
Posted by GitBox <gi...@apache.org>.
zhongjiajie commented on code in PR #1740:
URL: https://github.com/apache/incubator-seatunnel/pull/1740#discussion_r861424497
##########
docs/sidebars.js:
##########
@@ -68,14 +68,20 @@ const sidebars = {
items: [
'start/local',
'start/docker',
- 'start/kubernetes',
+ 'start/kubernetes'
+ ],
+ },
+ {
+ type: 'category',
+ label: 'Basic Concept',
Review Comment:
```suggestion
label: 'Concept',
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@seatunnel.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-seatunnel] zhongjiajie commented on a diff in pull request #1740: [Feature][Doc] Add Config file introduce.
Posted by GitBox <gi...@apache.org>.
zhongjiajie commented on code in PR #1740:
URL: https://github.com/apache/incubator-seatunnel/pull/1740#discussion_r861424044
##########
docs/sidebars.js:
##########
@@ -68,14 +75,13 @@ const sidebars = {
items: [
'start/local',
'start/docker',
- 'start/kubernetes',
+ 'start/kubernetes'
],
},
{
Review Comment:
```suggestion
{
type: 'category',
label: 'Basic Concept',
items: [
'concept/config',
],
},
{
```
##########
docs/sidebars.js:
##########
@@ -54,6 +54,13 @@ const sidebars = {
'intro/history',
],
},
+ {
+ type: 'category',
+ label: 'Basic Concept',
+ items: [
+ 'concept/config',
+ ],
+ },
Review Comment:
```suggestion
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@seatunnel.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-seatunnel] BenJFan commented on pull request #1740: [Feature][Doc] Add Config file introduce.
Posted by GitBox <gi...@apache.org>.
BenJFan commented on PR #1740:
URL: https://github.com/apache/incubator-seatunnel/pull/1740#issuecomment-1108256270
@zhongjiajie Hi, PTAL
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@seatunnel.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-seatunnel] zhongjiajie commented on pull request #1740: [Feature][Doc] Add Config file introduce.
Posted by GitBox <gi...@apache.org>.
zhongjiajie commented on PR #1740:
URL: https://github.com/apache/incubator-seatunnel/pull/1740#issuecomment-1110495829
take a look now
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@seatunnel.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org