You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@impala.apache.org by Tamás Máté <tm...@apache.org> on 2022/11/14 12:34:15 UTC

Re: [DISCUSS] Prettify Apache site docs

Thanks everyone for the input. The base commit for the change can be found
here:
https://gerrit.cloudera.org/#/c/19242/
let me know your thoughts.

The docs can be built with:
---
cd docs
make asf-site-html
---
The result index.html should be: docs/build/asf-site-html/index.html

Also, I think it would be better to point the
https://impala.apache.org/impala-docs.html to
https://impala.apache.org/docs/build/html/topics/impala_intro.html instead
of index.html,
but this would be a deploying step.

On Thu, 20 Oct 2022 at 12:36, Baike Xia <xi...@163.com> wrote:

> +1,  that's great.
>
>
> Regards,
> Baike Xia
>
>
>
>
>
> At 2022-10-20 11:49:32, "xiaoqing gao" <ga...@gmail.com> wrote:
> >+1, the new document is much better.
> >
> >gaoxiaoqing
> >
> >
> >李鹏霖 <li...@sensorsdata.cn> 于2022年10月20日周四 12:32写道:
> >
> >> +1
> >> Actually I prefer the old style, but the new style should be more
> >> acceptable to all users.
> >>
> >>
> >> Regards,
> >> LiPenglin
> >>
> >>
> >>        ----------回复的邮件信息----------
> >>        Jian Zhang<zjsariel@gmail.com&gt;&nbsp;在2022年10月20日(星期四)
> 上午9:19写道:
> >>
> >>
> >>
> >> +1, the new document looks great
> >>
> >>
> >> &gt; On Oct 19, 2022, at 20:12, Xiang Yang <yx91490@126.com&gt; wrote:
> >> &gt;
> >> &gt; +1 for 'change the user facing documentation on the Apache site'.
> >> &gt;
> >> &gt;
> >> &gt;
> >> &gt;
> >> &gt; Regards,
> >> &gt; Xiang Yang
> >> &gt;
> >> &gt;
> >> &gt;
> >> &gt;
> >> &gt; At 2022-10-19 20:04:37,"Gergely Fürnstáhl" <
> gfurnstahl@cloudera.com&gt;,
> >> said:
> >> &gt;&gt; +1, great idea, I prefer using the HTML one over the PDF, this
> >> would make
> >> &gt;&gt; the experience a lot better.
> >> &gt;&gt;
> >> &gt;&gt;
> >> &gt;&gt; On Wed, Oct 19, 2022 at 12:35 PM Zoltán Borók-Nagy <
> >> boroknagyz@cloudera.com&gt;
> >> &gt;&gt; wrote:
> >> &gt;&gt;
> >> &gt;&gt;&gt; +1, thanks for bringing this up.
> >> &gt;&gt;&gt;
> >> &gt;&gt;&gt; - Zoltan
> >> &gt;&gt;&gt;
> >> &gt;&gt;&gt; On Wed, Oct 19, 2022 at 11:02 AM Tamás Máté <
> >> tmater@apache.org&gt; wrote:
> >> &gt;&gt;&gt;
> >> &gt;&gt;&gt;&gt; Hi Team,
> >> &gt;&gt;&gt;&gt;
> >> &gt;&gt;&gt;&gt; we are having a few discussion threads lately, here is
> >> another one. :)
> >> &gt;&gt;&gt;&gt;
> >> &gt;&gt;&gt;&gt; We are releasing quite plain html docs on the Apache
> >> Impala site, which I
> >> &gt;&gt;&gt;&gt; really like, but from user perspective I believe it is
> >> harder to digest.
> >> &gt;&gt;&gt; I
> >> &gt;&gt;&gt;&gt; think adding a side navigation bar and some color would
> >> make it a bit
> >> &gt;&gt;&gt; more
> >> &gt;&gt;&gt;&gt; accessible, so I played a bit with dita and dita's own
> >> doc template and
> >> &gt;&gt;&gt;&gt; came up with this:
> >> &gt;&gt;&gt;&gt;
> >> &gt;&gt;&gt;
> >>
> https://issues.apache.org/jira/secure/attachment/13051169/doc_style_v1.png
> >> &gt;&gt;&gt;&gt; for comparison the current page:
> >> &gt;&gt;&gt;&gt;
> >> &gt;&gt;&gt;
> >>
> https://impala.apache.org/docs/build/html/topics/impala_config_options.html
> >> &gt;&gt;&gt;&gt; .
> >> &gt;&gt;&gt;&gt;
> >> &gt;&gt;&gt;&gt; We should keep the plain xhtml docs as well in case
> >> someone would like to
> >> &gt;&gt;&gt;&gt; embed it. What I would like to propose is to change the
> >> user facing
> >> &gt;&gt;&gt;&gt; documentation on the Apache site. What do you think?
> >> &gt;&gt;&gt;&gt;
> >> &gt;&gt;&gt;&gt; Best regards,
> >> &gt;&gt;&gt;&gt; Tamas
> >> &gt;&gt;&gt;&gt;
> >> &gt;&gt;&gt;
>