You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@doris.apache.org by ling miao <li...@apache.org> on 2021/11/19 02:58:56 UTC

[DISCUSS] Where to put the blog resources?

First of all, I am looking forward to the blog feature very much.
But when I was reviewing blog posts, I found that general blog posts will
carry a lot of resources, such as pictures.
In the future, we will definitely add a lot of blog posts. Will this lead
to a larger and larger code base?
If the answer is yes, is it a correct operation for us to put the resouces
of these blog articles in the code base?
Or how do other projects manage these blogs?

Ling Miao

Re:[DISCUSS] Where to put the blog resources?

Posted by 陈明雨 <mo...@163.com>.
Yes, I have discussed with @hf200012 yesterday about this issue.


There are 3 ways we can do:


1. Move the entire `docs/` dir to the other code repo[1]


    This can solve the problem of the main repo being too large. But the trouble is that when we update other functional documents, we need to submit PRs to the code repo on both sides, which is more cumbersome.


2. Try to limit the number and format of pictures


    We tried to use `svg` format. But in some cases, the size of svg turned out to be larger than the compressed `png` format.


3. Use external links


    Use external links of images in blogs. So that the contributor need first post its blog to some other blog website. And than refer to that.
    But I am not sure it is ok to use external links in Apache project's website.


So my suggestion is to use the compressed png format in the early stage, and try to limit the size and number of pictures.
If this does become a problem, we can consider other options


[1]  https://github.com/apache/incubator-doris-website



--

此致!Best Regards
陈明雨 Mingyu Chen

Email:
chenmingyu@apache.org





At 2021-11-19 10:58:56, "ling miao" <li...@apache.org> wrote:
>First of all, I am looking forward to the blog feature very much.
>But when I was reviewing blog posts, I found that general blog posts will
>carry a lot of resources, such as pictures.
>In the future, we will definitely add a lot of blog posts. Will this lead
>to a larger and larger code base?
>If the answer is yes, is it a correct operation for us to put the resouces
>of these blog articles in the code base?
>Or how do other projects manage these blogs?
>
>Ling Miao

Re: Re:Re: [DISCUSS] Where to put the blog resources?

Posted by 41108453 <41...@qq.com.INVALID>.
+1





------------------ Original ------------------
From: 陈明雨 <morningman@163.com&gt;
Date: Tue,Dec 21,2021 6:56 PM
To: dev <dev@doris.apache.org&gt;
Subject: Re: Re:Re: [DISCUSS] Where to put the blog resources?



Hi All:
Finally, I am going to put the blogs to the incubator-doris-website repo. You can see README[1].
So that all following new blogs should be push to the incubator-doris-website repo, and the github action
will automatically merge it with the `docs/` of main repo, and update the website.


[1] https://github.com/apache/incubator-doris-website




--

此致!Best Regards
陈明雨 Mingyu Chen

Email:
chenmingyu@apache.org





在 2021-11-19 13:17:54,"ling miao" <lingmiao@apache.org&gt; 写道:
&gt;Putting the document in another code base is indeed a solution,
&gt;but this requires us to ensure the **collaborative compilation** of the
&gt;document library and the code base when compiling.
&gt;Because the current Doris system is a built-in help document,
&gt;and it also needs to be synchronized to the website.
&gt;
&gt;Ling Miao
&gt;
&gt;Gabriel Lee <gabrielleebuaa@gmail.com&gt; 于2021年11月19日周五 下午1:01写道:
&gt;
&gt;&gt; I think it will be a serious problem soon. Could we maintain the
&gt;&gt; doris-website project separately? It means we should update documents or
&gt;&gt; upload a blog post in doris-website instead of doris. This will keep doris
&gt;&gt; project in a reasonable size but increase maintenance cost.
&gt;&gt;
&gt;&gt; On Fri, 19 Nov 2021 at 10:59, ling miao <lingmiao@apache.org&gt; wrote:
&gt;&gt;
&gt;&gt; &gt; First of all, I am looking forward to the blog feature very much.
&gt;&gt; &gt; But when I was reviewing blog posts, I found that general blog posts will
&gt;&gt; &gt; carry a lot of resources, such as pictures.
&gt;&gt; &gt; In the future, we will definitely add a lot of blog posts. Will this lead
&gt;&gt; &gt; to a larger and larger code base?
&gt;&gt; &gt; If the answer is yes, is it a correct operation for us to put the
&gt;&gt; resouces
&gt;&gt; &gt; of these blog articles in the code base?
&gt;&gt; &gt; Or how do other projects manage these blogs?
&gt;&gt; &gt;
&gt;&gt; &gt; Ling Miao
&gt;&gt; &gt;
&gt;&gt;

Re:Re: [DISCUSS] Where to put the blog resources?

Posted by 陈明雨 <mo...@163.com>.
Hi All:
Finally, I am going to put the blogs to the incubator-doris-website repo. You can see README[1].
So that all following new blogs should be push to the incubator-doris-website repo, and the github action
will automatically merge it with the `docs/` of main repo, and update the website.


[1] https://github.com/apache/incubator-doris-website




--

此致!Best Regards
陈明雨 Mingyu Chen

Email:
chenmingyu@apache.org





在 2021-11-19 13:17:54,"ling miao" <li...@apache.org> 写道:
>Putting the document in another code base is indeed a solution,
>but this requires us to ensure the **collaborative compilation** of the
>document library and the code base when compiling.
>Because the current Doris system is a built-in help document,
>and it also needs to be synchronized to the website.
>
>Ling Miao
>
>Gabriel Lee <ga...@gmail.com> 于2021年11月19日周五 下午1:01写道:
>
>> I think it will be a serious problem soon. Could we maintain the
>> doris-website project separately? It means we should update documents or
>> upload a blog post in doris-website instead of doris. This will keep doris
>> project in a reasonable size but increase maintenance cost.
>>
>> On Fri, 19 Nov 2021 at 10:59, ling miao <li...@apache.org> wrote:
>>
>> > First of all, I am looking forward to the blog feature very much.
>> > But when I was reviewing blog posts, I found that general blog posts will
>> > carry a lot of resources, such as pictures.
>> > In the future, we will definitely add a lot of blog posts. Will this lead
>> > to a larger and larger code base?
>> > If the answer is yes, is it a correct operation for us to put the
>> resouces
>> > of these blog articles in the code base?
>> > Or how do other projects manage these blogs?
>> >
>> > Ling Miao
>> >
>>

Re: [DISCUSS] Where to put the blog resources?

Posted by ling miao <li...@apache.org>.
Putting the document in another code base is indeed a solution,
but this requires us to ensure the **collaborative compilation** of the
document library and the code base when compiling.
Because the current Doris system is a built-in help document,
and it also needs to be synchronized to the website.

Ling Miao

Gabriel Lee <ga...@gmail.com> 于2021年11月19日周五 下午1:01写道:

> I think it will be a serious problem soon. Could we maintain the
> doris-website project separately? It means we should update documents or
> upload a blog post in doris-website instead of doris. This will keep doris
> project in a reasonable size but increase maintenance cost.
>
> On Fri, 19 Nov 2021 at 10:59, ling miao <li...@apache.org> wrote:
>
> > First of all, I am looking forward to the blog feature very much.
> > But when I was reviewing blog posts, I found that general blog posts will
> > carry a lot of resources, such as pictures.
> > In the future, we will definitely add a lot of blog posts. Will this lead
> > to a larger and larger code base?
> > If the answer is yes, is it a correct operation for us to put the
> resouces
> > of these blog articles in the code base?
> > Or how do other projects manage these blogs?
> >
> > Ling Miao
> >
>

Re: [DISCUSS] Where to put the blog resources?

Posted by Gabriel Lee <ga...@gmail.com>.
I think it will be a serious problem soon. Could we maintain the
doris-website project separately? It means we should update documents or
upload a blog post in doris-website instead of doris. This will keep doris
project in a reasonable size but increase maintenance cost.

On Fri, 19 Nov 2021 at 10:59, ling miao <li...@apache.org> wrote:

> First of all, I am looking forward to the blog feature very much.
> But when I was reviewing blog posts, I found that general blog posts will
> carry a lot of resources, such as pictures.
> In the future, we will definitely add a lot of blog posts. Will this lead
> to a larger and larger code base?
> If the answer is yes, is it a correct operation for us to put the resouces
> of these blog articles in the code base?
> Or how do other projects manage these blogs?
>
> Ling Miao
>