You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@calcite.apache.org by xiong duan <no...@gmail.com> on 2021/12/28 22:44:50 UTC
[SITE-IMPROVEMENT] Issue need to confirm about the API web
After checking the regenerate the Web, I noticed a small problem with the
Calcite API URI https://calcite.apache.org/javadocAggregate/ . The doc
title should be "Apache Calcite API", but is "Apache Calcite calcite API".
Same as Avatica, The doc title should be " Apache Calcite Avatica API", but
is "Apache Calcite Avatica calcite-avatica API". I think this is a problem.
Do you think so?
Re: [SITE-IMPROVEMENT] Issue need to confirm about the API web
Posted by Julian Hyde <jh...@gmail.com>.
+1
> On Dec 28, 2021, at 7:11 PM, Zhe Hu <il...@163.com> wrote:
>
> +1 for removing the redundant lowercase “calcite”/”calcite-avatica”.
>
>
> Best,
> ZheHu
>
>
>
>
> On 12/29/2021 10:44，Chunwei Lei<ch...@gmail.com> wrote：
> Sounds reasonable to me.
>
>
> Best,
> Chunwei
>
>
> On Wed, Dec 29, 2021 at 6:44 AM xiong duan <no...@gmail.com> wrote:
>
> After checking the regenerate the Web, I noticed a small problem with the
> Calcite API URI https://calcite.apache.org/javadocAggregate/ . The doc
> title should be "Apache Calcite API", but is "Apache Calcite calcite API".
> Same as Avatica, The doc title should be " Apache Calcite Avatica API", but
> is "Apache Calcite Avatica calcite-avatica API". I think this is a problem.
> Do you think so?
>
Re: [SITE-IMPROVEMENT] Issue need to confirm about the API web
Posted by Zhe Hu <il...@163.com>.
+1 for removing the redundant lowercase “calcite”/”calcite-avatica”.
Best,
ZheHu
On 12/29/2021 10:44，Chunwei Lei<ch...@gmail.com> wrote：
Sounds reasonable to me.
Best,
Chunwei
On Wed, Dec 29, 2021 at 6:44 AM xiong duan <no...@gmail.com> wrote:
After checking the regenerate the Web, I noticed a small problem with the
Calcite API URI https://calcite.apache.org/javadocAggregate/ . The doc
title should be "Apache Calcite API", but is "Apache Calcite calcite API".
Same as Avatica, The doc title should be " Apache Calcite Avatica API", but
is "Apache Calcite Avatica calcite-avatica API". I think this is a problem.
Do you think so?
Re: [SITE-IMPROVEMENT] Issue need to confirm about the API web
Posted by Chunwei Lei <ch...@gmail.com>.
Sounds reasonable to me.
Best,
Chunwei
On Wed, Dec 29, 2021 at 6:44 AM xiong duan <no...@gmail.com> wrote:
> After checking the regenerate the Web, I noticed a small problem with the
> Calcite API URI https://calcite.apache.org/javadocAggregate/ . The doc
> title should be "Apache Calcite API", but is "Apache Calcite calcite API".
> Same as Avatica, The doc title should be " Apache Calcite Avatica API", but
> is "Apache Calcite Avatica calcite-avatica API". I think this is a problem.
> Do you think so?
>
Re: [SITE-IMPROVEMENT] Issue need to confirm about the API web
Posted by Stamatis Zampetakis <za...@gmail.com>.
The easiest would be to wrap code with {% highlight java %} / {% highlight
bash %}, which is also used in various other places of the .md file
already, instead of back-ticks. Like that there will be a horizontal scroll
bar when needed.
Alternatively as Julian mentioned we can change the wrapping behavior of
code blocks via CSS, using for instance the whitespace attribute [1]
although the latter will not make any difference if there are no
whitespaces.
Best,
Stamatis
[1] https://developer.mozilla.org/en-US/docs/Web/CSS/white-space
On Fri, Jan 7, 2022 at 8:52 PM Julian Hyde <jh...@gmail.com> wrote:
> You’re right, those 3 examples don’t look great. They all seem to be
> caused by Jekyll’s code block (back-ticks), e.g.
> https://github.com/apache/calcite/blame/cbda134d8e75a8a5c63a1aa9bcddab6fc6756021/site/_docs/howto.md#L73
> <
> https://github.com/apache/calcite/blame/cbda134d8e75a8a5c63a1aa9bcddab6fc6756021/site/_docs/howto.md#L73
> >.
>
> Does anyone who knows a bit more Jekyll or CSS than me (not a very high
> bar!) have any ideas how to make this better? Maybe make the code font one
> or two points smaller? Insert optional line-breaks in long strings?
>
> Julian
>
>
> > On Jan 7, 2022, at 9:23 AM, Zhe Hu <il...@163.com> wrote:
> >
> > Hi, I have one small suggestion for the SITE_IMPROVEMENT.
> > Recently，when I browse howto.html through Chrome Explorer, I’ve found
> that some lines are too long, which causes a little bit format
> disorder(just based on my personal preference). I’ll pick several cases in
> howto.md below:
> > (1) Line 73: However, if your IDE does not generate sources…
> > (2) Line 262: `Exception in thread “main”...
> > (3) Line 785: “Troubleshooting” character
> >
> >
> > Best,
> > ZheHu
> >
> >
> >
> >
> > On 12/29/2021 06:44，xiong duan<no...@gmail.com> wrote：
> > After checking the regenerate the Web, I noticed a small problem with the
> > Calcite API URI https://calcite.apache.org/javadocAggregate/ . The doc
> > title should be "Apache Calcite API", but is "Apache Calcite calcite
> API".
> > Same as Avatica, The doc title should be " Apache Calcite Avatica API",
> but
> > is "Apache Calcite Avatica calcite-avatica API". I think this is a
> problem.
> > Do you think so?
>
>
Re: [SITE-IMPROVEMENT] Issue need to confirm about the API web
Posted by Julian Hyde <jh...@gmail.com>.
You’re right, those 3 examples don’t look great. They all seem to be caused by Jekyll’s code block (back-ticks), e.g. https://github.com/apache/calcite/blame/cbda134d8e75a8a5c63a1aa9bcddab6fc6756021/site/_docs/howto.md#L73 <https://github.com/apache/calcite/blame/cbda134d8e75a8a5c63a1aa9bcddab6fc6756021/site/_docs/howto.md#L73>.
Does anyone who knows a bit more Jekyll or CSS than me (not a very high bar!) have any ideas how to make this better? Maybe make the code font one or two points smaller? Insert optional line-breaks in long strings?
Julian
> On Jan 7, 2022, at 9:23 AM, Zhe Hu <il...@163.com> wrote:
>
> Hi, I have one small suggestion for the SITE_IMPROVEMENT.
> Recently，when I browse howto.html through Chrome Explorer, I’ve found that some lines are too long, which causes a little bit format disorder(just based on my personal preference). I’ll pick several cases in howto.md below:
> (1) Line 73: However, if your IDE does not generate sources…
> (2) Line 262: `Exception in thread “main”...
> (3) Line 785: “Troubleshooting” character
>
>
> Best,
> ZheHu
>
>
>
>
> On 12/29/2021 06:44，xiong duan<no...@gmail.com> wrote：
> After checking the regenerate the Web, I noticed a small problem with the
> Calcite API URI https://calcite.apache.org/javadocAggregate/ . The doc
> title should be "Apache Calcite API", but is "Apache Calcite calcite API".
> Same as Avatica, The doc title should be " Apache Calcite Avatica API", but
> is "Apache Calcite Avatica calcite-avatica API". I think this is a problem.
> Do you think so?
Re:[SITE-IMPROVEMENT] Issue need to confirm about the API web
Posted by Zhe Hu <il...@163.com>.
Hi, I have one small suggestion for the SITE_IMPROVEMENT.
Recently，when I browse howto.html through Chrome Explorer, I’ve found that some lines are too long, which causes a little bit format disorder(just based on my personal preference). I’ll pick several cases in howto.md below:
(1) Line 73: However, if your IDE does not generate sources…
(2) Line 262: `Exception in thread “main”...
(3) Line 785: “Troubleshooting” character
Best,
ZheHu
On 12/29/2021 06:44，xiong duan<no...@gmail.com> wrote：
After checking the regenerate the Web, I noticed a small problem with the
Calcite API URI https://calcite.apache.org/javadocAggregate/ . The doc
title should be "Apache Calcite API", but is "Apache Calcite calcite API".
Same as Avatica, The doc title should be " Apache Calcite Avatica API", but
is "Apache Calcite Avatica calcite-avatica API". I think this is a problem.
Do you think so?