ignite-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Павлухин Иван <vololo...@gmail.com>
Subject Re: Broken layout of Ignite javadoc on web
Date Wed, 12 Jun 2019 18:43:20 GMT
I went through a couple of pages and layout looks good.

A couple of aside notes:
1. There is a label "Ignite - In-Memory Database and Caching
Platform". Do we need that label at all? Can we replace it with a link
having text "Ignite" and referring to ignite.apache.org?
2. The copyright is out of date "2018 Copyright © Apache Software Foundation".

вт, 11 июн. 2019 г. в 19:22, Denis Magda <dmagda@apache.org>:
>
> + Sergey
>
> -
> Denis
>
>
> On Tue, Jun 11, 2019 at 9:21 AM Denis Magda <dmagda@apache.org> wrote:
>
> > Sergey,
> >
> > Could you please chime in? I do believe we have special tests to ensure
> > the javadoc is not broken. Visually, everything looks good. But I'll
> > encourage others to double check.
> >
> > -
> > Denis
> >
> >
> > On Tue, Jun 11, 2019 at 7:04 AM Dmitriy Pavlov <dpavlov@apache.org> wrote:
> >
> >> Igniters, Ivan,
> >>
> >> could you please verify new release JavaDoc doesn't have same problems:
> >> https://ignite.apache.org/releases/2.7.5/javadoc/
> >>
> >> Sincerely,
> >> Dmitriy Pavlov
> >>
> >> чт, 31 янв. 2019 г. в 21:30, Dmitriy Pavlov <dpavlov@apache.org>:
> >>
> >> > Sure, I don't see any issues with using the default style. It is
> >> > definitely better than broken CSS.
> >> >
> >> > Thank you for accurate & detailed research.
> >> >
> >> > If nobody minds I could apply a patch with a switch to defaults.
> >> >
> >> > чт, 31 янв. 2019 г. в 11:11, Павлухин Иван <vololo100@gmail.com>:
> >> >
> >> >> Hi,
> >> >>
> >> >> Continuation of the story. I build javadocs locally and checked how
it
> >> >> renders with manually added images. Unfortunately there are several
> >> >> visible artifacts. I guess the reason here is that stylesheet and
> >> >> images was suitable for an older version of javadoc maven plugin but
> >> >> not for a newer one.
> >> >>
> >> >> Also I noticed that style used by Ignite is similar to Java 7 docs
> >> >> [1]. Different style is used since Java 8 [2]. And it looks like by
> >> >> default maven javadoc plugin today builds similar pages. You can see
> >> >> an example of Ignite javadoc built with default style [3].
> >> >>
> >> >> So, perhaps we can use a default style for our documentation, cannot
> >> we?
> >> >>
> >> >> [1] https://docs.oracle.com/javase/7/docs/api/java/util/BitSet.html
> >> >> [2]
> >> >>
> >> https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/BitSet.html
> >> >> [3] https://gist.github.com/pavlukhin/c627b31c09e4f1ae7bd04f11bafed040
> >> >>
> >> >> пн, 24 дек. 2018 г. в 17:34, Павлухин Иван <vololo100@gmail.com>:
> >> >> >
> >> >> > Hi,
> >> >> >
> >> >> > Mentioned javadoc.css references to some image resources. They
> >> present
> >> >> > for 2.3.0 release [1]. But similar url returns 404 for 2.7.0 [2].
Who
> >> >> > knows how to upload resources?
> >> >> >
> >> >> > [1] https://ignite.apache.org/releases/2.3.0/javadoc/resources
> >> >> > [2] https://ignite.apache.org/releases/2.7.0/javadoc/resources
> >> >> >
> >> >> > пн, 17 дек. 2018 г. в 16:38, Павлухин Иван
<vololo100@gmail.com>:
> >> >> >
> >> >> > >
> >> >> > > Dmitriy,
> >> >> > >
> >> >> > > Yep, it looks like the problem is inside
> >> assembly/docfiles/javadoc.css
> >> >> > >
> >> >> > > I will try to dig into some time later on a spare time. Of
course,
> >> if
> >> >> > > nobody fixes the problem earlier.
> >> >> > > пн, 17 дек. 2018 г. в 15:18, Dmitriy Pavlov <dpavlov@apache.org>:
> >> >> > > >
> >> >> > > > I see the same, browsers checked: Edge & Chrome.
I guess it is
> >> not
> >> >> a layout
> >> >> > > > is broken, but a style missing.
> >> >> > > >
> >> >> > > > Unfortunately, I don't know how to fix. Probably we
should start
> >> >> research
> >> >> > > > from ignite/pom.xml:191
> >> >> > > >
> >> >> > > >
> >> >>
> >> <stylesheetfile>${basedir}/assembly/docfiles/javadoc.css</stylesheetfile>
> >> >> > > >
> >> >> > > >
> >> >> > > > пн, 17 дек. 2018 г. в 14:32, Павлухин
Иван <vololo100@gmail.com
> >> >:
> >> >> > > >
> >> >> > > > > Hi,
> >> >> > > > >
> >> >> > > > > I noticed that Ignite javadoc layout on web for
latest versions
> >> >> has
> >> >> > > > > some problems. For example, I see no links near
the "Class" at
> >> >> heading
> >> >> > > > > of the page [1]. Here is a screenshot [2]. Do you
see the same?
> >> >> > > > >
> >> >> > > > > I was able to build javadoc on my machine. With
current
> >> >> configuration
> >> >> > > > > I see the same broken layout. After using commenting
out
> >> >> customized
> >> >> > > > > style sheet configuration (referring to
> >> >> assembly/docfiles/javadoc.css)
> >> >> > > > > I was able to obtain an html which renders fine
for me.
> >> >> > > > >
> >> >> > > > > Can anyone suggest a simple solution for this?
> >> >> > > > >
> >> >> > > > > [1]
> >> >> > > > >
> >> >>
> >> https://ignite.apache.org/releases/2.7.0/javadoc/org/apache/ignite/cache/eviction/EvictionPolicy.html
> >> >> > > > > [2]
> >> >> > > > >
> >> >>
> >> https://gist.githubusercontent.com/pavlukhin/c8c7c6266eeab56048c31f5cdfb31d20/raw/1b257ad73f81cb4698f6105a9d1646295ba55795/javadoc_layout.png
> >> >> > > > >
> >> >> > > > > --
> >> >> > > > > Best regards,
> >> >> > > > > Ivan Pavlukhin
> >> >> > > > >
> >> >> > >
> >> >> > >
> >> >> > >
> >> >> > > --
> >> >> > > Best regards,
> >> >> > > Ivan Pavlukhin
> >> >> >
> >> >> >
> >> >> >
> >> >> > --
> >> >> > Best regards,
> >> >> > Ivan Pavlukhin
> >> >>
> >> >>
> >> >>
> >> >> --
> >> >> Best regards,
> >> >> Ivan Pavlukhin
> >> >>
> >> >
> >>
> >



-- 
Best regards,
Ivan Pavlukhin

Mime
View raw message