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/10/19 09:01:59 UTC

[DISCUSS] Prettify Apache site docs

Hi Team,

we are having a few discussion threads lately, here is another one. :)

We are releasing quite plain html docs on the Apache Impala site, which I
really like, but from user perspective I believe it is harder to digest. I
think adding a side navigation bar and some color would make it a bit more
accessible, so I played a bit with dita and dita's own doc template and
came up with this:
https://issues.apache.org/jira/secure/attachment/13051169/doc_style_v1.png
for comparison the current page:
https://impala.apache.org/docs/build/html/topics/impala_config_options.html
.

We should keep the plain xhtml docs as well in case someone would like to
embed it. What I would like to propose is to change the user facing
documentation on the Apache site. What do you think?

Best regards,
Tamas

Re: [DISCUSS] Prettify Apache site docs

Posted by Quanlong Huang <hu...@gmail.com>.
+1. That's much better than the current one.

Thanks,
Quanlong

On Wed, Oct 19, 2022 at 8:05 PM Gergely Fürnstáhl <gf...@cloudera.com>
wrote:

> +1, great idea, I prefer using the HTML one over the PDF, this would make
> the experience a lot better.
>
>
> On Wed, Oct 19, 2022 at 12:35 PM Zoltán Borók-Nagy <
> boroknagyz@cloudera.com>
> wrote:
>
> > +1, thanks for bringing this up.
> >
> > - Zoltan
> >
> > On Wed, Oct 19, 2022 at 11:02 AM Tamás Máté <tm...@apache.org> wrote:
> >
> > > Hi Team,
> > >
> > > we are having a few discussion threads lately, here is another one. :)
> > >
> > > We are releasing quite plain html docs on the Apache Impala site,
> which I
> > > really like, but from user perspective I believe it is harder to
> digest.
> > I
> > > think adding a side navigation bar and some color would make it a bit
> > more
> > > accessible, so I played a bit with dita and dita's own doc template and
> > > came up with this:
> > >
> >
> https://issues.apache.org/jira/secure/attachment/13051169/doc_style_v1.png
> > > for comparison the current page:
> > >
> >
> https://impala.apache.org/docs/build/html/topics/impala_config_options.html
> > > .
> > >
> > > We should keep the plain xhtml docs as well in case someone would like
> to
> > > embed it. What I would like to propose is to change the user facing
> > > documentation on the Apache site. What do you think?
> > >
> > > Best regards,
> > > Tamas
> > >
> >
>

Re: [DISCUSS] Prettify Apache site docs

Posted by Jian Zhang <zj...@gmail.com>.
+1, the new document looks great


> On Oct 19, 2022, at 20:12, Xiang Yang <yx...@126.com> wrote:
> 
> +1 for 'change the user facing documentation on the Apache site'.
> 
> 
> 
> 
> Regards,
> Xiang Yang
> 
> 
> 
> 
> At 2022-10-19 20:04:37,"Gergely Fürnstáhl" <gf...@cloudera.com>, said: 
>> +1, great idea, I prefer using the HTML one over the PDF, this would make
>> the experience a lot better.
>> 
>> 
>> On Wed, Oct 19, 2022 at 12:35 PM Zoltán Borók-Nagy <bo...@cloudera.com>
>> wrote:
>> 
>>> +1, thanks for bringing this up.
>>> 
>>> - Zoltan
>>> 
>>> On Wed, Oct 19, 2022 at 11:02 AM Tamás Máté <tm...@apache.org> wrote:
>>> 
>>>> Hi Team,
>>>> 
>>>> we are having a few discussion threads lately, here is another one. :)
>>>> 
>>>> We are releasing quite plain html docs on the Apache Impala site, which I
>>>> really like, but from user perspective I believe it is harder to digest.
>>> I
>>>> think adding a side navigation bar and some color would make it a bit
>>> more
>>>> accessible, so I played a bit with dita and dita's own doc template and
>>>> came up with this:
>>>> 
>>> https://issues.apache.org/jira/secure/attachment/13051169/doc_style_v1.png
>>>> for comparison the current page:
>>>> 
>>> https://impala.apache.org/docs/build/html/topics/impala_config_options.html
>>>> .
>>>> 
>>>> We should keep the plain xhtml docs as well in case someone would like to
>>>> embed it. What I would like to propose is to change the user facing
>>>> documentation on the Apache site. What do you think?
>>>> 
>>>> Best regards,
>>>> Tamas
>>>> 
>>>

Re: [DISCUSS] Prettify Apache site docs

Posted by Xiang Yang <yx...@126.com>.
+1 for 'change the user facing documentation on the Apache site'.




Regards,
Xiang Yang




At 2022-10-19 20:04:37,"Gergely Fürnstáhl" <gf...@cloudera.com>, said: 
>+1, great idea, I prefer using the HTML one over the PDF, this would make
>the experience a lot better.
>
>
>On Wed, Oct 19, 2022 at 12:35 PM Zoltán Borók-Nagy <bo...@cloudera.com>
>wrote:
>
>> +1, thanks for bringing this up.
>>
>> - Zoltan
>>
>> On Wed, Oct 19, 2022 at 11:02 AM Tamás Máté <tm...@apache.org> wrote:
>>
>> > Hi Team,
>> >
>> > we are having a few discussion threads lately, here is another one. :)
>> >
>> > We are releasing quite plain html docs on the Apache Impala site, which I
>> > really like, but from user perspective I believe it is harder to digest.
>> I
>> > think adding a side navigation bar and some color would make it a bit
>> more
>> > accessible, so I played a bit with dita and dita's own doc template and
>> > came up with this:
>> >
>> https://issues.apache.org/jira/secure/attachment/13051169/doc_style_v1.png
>> > for comparison the current page:
>> >
>> https://impala.apache.org/docs/build/html/topics/impala_config_options.html
>> > .
>> >
>> > We should keep the plain xhtml docs as well in case someone would like to
>> > embed it. What I would like to propose is to change the user facing
>> > documentation on the Apache site. What do you think?
>> >
>> > Best regards,
>> > Tamas
>> >
>>

Re: [DISCUSS] Prettify Apache site docs

Posted by Gergely Fürnstáhl <gf...@cloudera.com>.
+1, great idea, I prefer using the HTML one over the PDF, this would make
the experience a lot better.


On Wed, Oct 19, 2022 at 12:35 PM Zoltán Borók-Nagy <bo...@cloudera.com>
wrote:

> +1, thanks for bringing this up.
>
> - Zoltan
>
> On Wed, Oct 19, 2022 at 11:02 AM Tamás Máté <tm...@apache.org> wrote:
>
> > Hi Team,
> >
> > we are having a few discussion threads lately, here is another one. :)
> >
> > We are releasing quite plain html docs on the Apache Impala site, which I
> > really like, but from user perspective I believe it is harder to digest.
> I
> > think adding a side navigation bar and some color would make it a bit
> more
> > accessible, so I played a bit with dita and dita's own doc template and
> > came up with this:
> >
> https://issues.apache.org/jira/secure/attachment/13051169/doc_style_v1.png
> > for comparison the current page:
> >
> https://impala.apache.org/docs/build/html/topics/impala_config_options.html
> > .
> >
> > We should keep the plain xhtml docs as well in case someone would like to
> > embed it. What I would like to propose is to change the user facing
> > documentation on the Apache site. What do you think?
> >
> > Best regards,
> > Tamas
> >
>

Re: [DISCUSS] Prettify Apache site docs

Posted by Zoltán Borók-Nagy <bo...@cloudera.com>.
+1, thanks for bringing this up.

- Zoltan

On Wed, Oct 19, 2022 at 11:02 AM Tamás Máté <tm...@apache.org> wrote:

> Hi Team,
>
> we are having a few discussion threads lately, here is another one. :)
>
> We are releasing quite plain html docs on the Apache Impala site, which I
> really like, but from user perspective I believe it is harder to digest. I
> think adding a side navigation bar and some color would make it a bit more
> accessible, so I played a bit with dita and dita's own doc template and
> came up with this:
> https://issues.apache.org/jira/secure/attachment/13051169/doc_style_v1.png
> for comparison the current page:
> https://impala.apache.org/docs/build/html/topics/impala_config_options.html
> .
>
> We should keep the plain xhtml docs as well in case someone would like to
> embed it. What I would like to propose is to change the user facing
> documentation on the Apache site. What do you think?
>
> Best regards,
> Tamas
>