You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@shardingsphere.apache.org by 吴晟 Sheng Wu <wu...@foxmail.com> on 2019/03/04 07:15:38 UTC

[SUGGESTION] Use the Infra to help the review, especially for doc repo

Hi.


I just accidentally noticed this pull request[1] about doc update. 
First of all, there is nothing wrong in this pr, don't worry, Trista. :P


I want to the community to notice is, this pull request includes a lot of generated codes, and 900+ files changed.
The question and concern is, if this pr comes from new contributor, such as not a PPMC member, how should we review the changes.


I will assume this PR is merged based on trust, that is fine. But I think we should consider more, since more contributors should be coming, or we expect they will come, right?


The suggestion is, 
Could we build the doc website based on ci script? Like SkyWalking's[2].
In there, SkyWalking just accept PR includes `md`, `images`, etc., but no generated file. Then, after PR merged, travis CI would generate the website, and push them to `asf` branch.


Of course, this is not hurry, you will have plenty time to optimize this. This is just a suggestion.




[1] https://github.com/apache/incubator-shardingsphere-doc/pull/81/files
[2] https://github.com/apache/incubator-skywalking-website


------------------
Sheng Wu
Apache SkyWalking, ShardingSphere, Zipkin
Twitter, wusheng1108

Re: [SUGGESTION] Use the Infra to help the review, especially for doc repo

Posted by Willem Jiang <wi...@gmail.com>.
+1 to use the tools to generate the website and push the change to
asf-site branch. (we don't need to put lots of effort to check these
changes.)
We just need to check the original content changes.

Willem Jiang

Twitter: willemjiang
Weibo: 姜宁willem

On Mon, Mar 4, 2019 at 3:16 PM 吴晟 Sheng Wu <wu...@foxmail.com> wrote:
>
> Hi.
>
>
> I just accidentally noticed this pull request[1] about doc update.
> First of all, there is nothing wrong in this pr, don't worry, Trista. :P
>
>
> I want to the community to notice is, this pull request includes a lot of generated codes, and 900+ files changed.
> The question and concern is, if this pr comes from new contributor, such as not a PPMC member, how should we review the changes.
>
>
> I will assume this PR is merged based on trust, that is fine. But I think we should consider more, since more contributors should be coming, or we expect they will come, right?
>
>
> The suggestion is,
> Could we build the doc website based on ci script? Like SkyWalking's[2].
> In there, SkyWalking just accept PR includes `md`, `images`, etc., but no generated file. Then, after PR merged, travis CI would generate the website, and push them to `asf` branch.
>
>
> Of course, this is not hurry, you will have plenty time to optimize this. This is just a suggestion.
>
>
>
>
> [1] https://github.com/apache/incubator-shardingsphere-doc/pull/81/files
> [2] https://github.com/apache/incubator-skywalking-website
>
>
> ------------------
> Sheng Wu
> Apache SkyWalking, ShardingSphere, Zipkin
> Twitter, wusheng1108