You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@seatunnel.apache.org by 李治霖 <zh...@gmail.com> on 2023/04/13 03:58:44 UTC
For the next new version of the official website Connetor document unified design
-
Why are we doing this?
1.At present, the documentation of our different connectors does not have a
complete unified format, which makes it difficult for users to intuitively
and quickly get started. For example, I do not have Seatunnel Data Type
mapping relationship with other data sources
2.The data Source is not visually visible without the support of the source
and Sink engines
-
For the above my proposal?
-
https://github.com/apache/incubator-seatunnel/issues/4544
-
Everyone has ideas to discuss together thank you!
Re: For the next new version of the official website Connetor document unified design
Posted by 陈卓宇 <mo...@apache.org>.
I wrote a guide for users on how to write connector documentation and hope
to do a better job of this.
https://z87p7jn1yv.feishu.cn/docx/BOIEda8WvorFGkx1JDpc2ZrJnNe
JUN GAO <ga...@apache.org> 于2023年4月13日周四 12:10写道：
> Some tips:
> A suitable title can help people get the purpose of the email faster.
> [Proposal]， [Discuss] can be add in the title of email.
>
> JUN GAO <ga...@apache.org> 于2023年4月13日周四 12:06写道：
>
> > Great, this is exactly what we urgently need.
> > Do we have stricter requirements for example? For example, to have the
> > simplest example and an example that includes all parameters?
> > Or some related parameters, such as for JDBC, is_exactly_once and
> > xa_data_source_class_name is a pair of associated parameters, and we need
> > an example to tell users how to use it?
> >
> > 李治霖 <zh...@gmail.com> 于2023年4月13日周四 11:59写道：
> >
> >> -
> >>
> >> Why are we doing this?
> >>
> >> 1.At present, the documentation of our different connectors does not
> have
> >> a
> >> complete unified format, which makes it difficult for users to
> intuitively
> >> and quickly get started. For example, I do not have Seatunnel Data Type
> >> mapping relationship with other data sources
> >> 2.The data Source is not visually visible without the support of the
> >> source
> >> and Sink engines
> >>
> >> -
> >>
> >> For the above my proposal?
> >> -
> >>
> >> https://github.com/apache/incubator-seatunnel/issues/4544
> >> -
> >>
> >> Everyone has ideas to discuss together thank you!
> >>
> >
> >
> > --
> >
> > Best Regards
> >
> > ------------
> >
> > EricJoy2048
> > gaojun2048@gmail.com
> >
> >
>
> --
>
> Best Regards
>
> ------------
>
> EricJoy2048
> gaojun2048@gmail.com
>
Re: For the next new version of the official website Connetor document unified design
Posted by JUN GAO <ga...@apache.org>.
Some tips:
A suitable title can help people get the purpose of the email faster.
[Proposal]， [Discuss] can be add in the title of email.
JUN GAO <ga...@apache.org> 于2023年4月13日周四 12:06写道：
> Great, this is exactly what we urgently need.
> Do we have stricter requirements for example? For example, to have the
> simplest example and an example that includes all parameters?
> Or some related parameters, such as for JDBC, is_exactly_once and
> xa_data_source_class_name is a pair of associated parameters, and we need
> an example to tell users how to use it?
>
> 李治霖 <zh...@gmail.com> 于2023年4月13日周四 11:59写道：
>
>> -
>>
>> Why are we doing this?
>>
>> 1.At present, the documentation of our different connectors does not have
>> a
>> complete unified format, which makes it difficult for users to intuitively
>> and quickly get started. For example, I do not have Seatunnel Data Type
>> mapping relationship with other data sources
>> 2.The data Source is not visually visible without the support of the
>> source
>> and Sink engines
>>
>> -
>>
>> For the above my proposal?
>> -
>>
>> https://github.com/apache/incubator-seatunnel/issues/4544
>> -
>>
>> Everyone has ideas to discuss together thank you!
>>
>
>
> --
>
> Best Regards
>
> ------------
>
> EricJoy2048
> gaojun2048@gmail.com
>
>
--
Best Regards
------------
EricJoy2048
gaojun2048@gmail.com
Re: For the next new version of the official website Connetor document unified design
Posted by JUN GAO <ga...@apache.org>.
Great, this is exactly what we urgently need.
Do we have stricter requirements for example? For example, to have the
simplest example and an example that includes all parameters?
Or some related parameters, such as for JDBC, is_exactly_once and
xa_data_source_class_name is a pair of associated parameters, and we need
an example to tell users how to use it?
李治霖 <zh...@gmail.com> 于2023年4月13日周四 11:59写道：
> -
>
> Why are we doing this?
>
> 1.At present, the documentation of our different connectors does not have a
> complete unified format, which makes it difficult for users to intuitively
> and quickly get started. For example, I do not have Seatunnel Data Type
> mapping relationship with other data sources
> 2.The data Source is not visually visible without the support of the source
> and Sink engines
>
> -
>
> For the above my proposal?
> -
>
> https://github.com/apache/incubator-seatunnel/issues/4544
> -
>
> Everyone has ideas to discuss together thank you!
>
--
Best Regards
------------
EricJoy2048
gaojun2048@gmail.com