ant-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Nicolas Lalevée <nicolas.lale...@hibnet.org>
Subject Re: Ivy documentation with asciidoc
Date Wed, 31 May 2017 21:00:40 GMT

> Le 31 mai 2017 à 19:47, Gintautas Grigelionis <g.grigelionis@gmail.com> a écrit
:
> 
> I looked at the documentation: both
> http://ant.apache.org/ivy/history/trunk/tutorial/start.html <http://ant.apache.org/ivy/history/trunk/tutorial/start.html>
and
> https://ant.apache.org/ivy/history/latest-milestone/tutorial/start.html <https://ant.apache.org/ivy/history/latest-milestone/tutorial/start.html>
> have black rectangles.

There should be the logs generated automatically there. These logs are generated by the task
generate-tutorial-output in the build-release.xml in the sources of Ivy.

I think the way we generate the website is incorrect regarding these logs, because building
the site is only about calling xooki, not generate the tutorial logs. Hence the empty black
rectangles. This need to be reviewed.
Probably while migrating to asciidoc, we should do like Matt suggested. When releasing, also
do a build of the doc, which will include the generation of the logs of the tutorial, and
then push manually the doc into the svn of the site.

> Also, external links must be pruned and/or directed to Internet Archive :-(
> The tutorial of yEd must be revised, version 3 has many more controls. I
> converted the odg diagrams to svg, and started looking at Ivy report/yEd
> screenshots. The original Ivy logo is unfortunately too low resolution for
> simple tracing :-( Is this all there is?

The only version of the logo we have is in the svn.

Nicolas

> 
> Gintas
> 
> 2017-05-31 18:20 GMT+02:00 Nicolas Lalevée <nicolas.lalevee@hibnet.org <mailto:nicolas.lalevee@hibnet.org>>:
> 
>> 
>>> Le 31 mai 2017 à 17:53, J Pai <jai.forums2013@gmail.com <mailto:jai.forums2013@gmail.com>>
a écrit :
>>> 
>>> 
>>> On 31-May-2017, at 9:02 PM, Nicolas Lalevée <nicolas.lalevee@hibnet.org <mailto:nicolas.lalevee@hibnet.org>
>> <mailto:nicolas.lalevee@hibnet.org <mailto:nicolas.lalevee@hibnet.org>>>
wrote:
>>> 
>>> 
>>>> Le 31 mai 2017 à 15:34, J Pai <jai.forums2013@gmail.com> a écrit
:
>>>> 
>>>> One thing I just noticed in the generated adoc files is that “external”
>> links that are part of the original xooki backed .html files are not being
>> generated as links in the converted adoc. To see a couple of example, take
>> a look at this hibnet.org/tmp/ivy-asciidoc/index.html page. The “Apache
>> License” in this sentence:
>>>> 
>>>>> Ivy is open source and released under a very permissive Apache License.
>>>>> 
>>>> 
>>>> 
>>>> and the “features” in :
>>>> 
>>>>> Ivy has a lot of powerful features
>>>> 
>>>> are actually link references in the original xooki backed docs of the
>> form [[license Apache License]] and [[features]].
>>> 
>>>> It seems that xooki doesn’t generate links either:
>>>> http://ant.apache.org/ivy/history/trunk/index.html <http://ant.apache.org/ivy/history/trunk/index.html>
<
>> http://ant.apache.org/ivy/history/trunk/index.html <http://ant.apache.org/ivy/history/trunk/index.html>>
<
>> http://ant.apache.org/ivy/history/trunk/index.html <http://ant.apache.org/ivy/history/trunk/index.html>
<
>> http://ant.apache.org/ivy/history/trunk/index.html <http://ant.apache.org/ivy/history/trunk/index.html>>>
>>>> 
>>>> Probably the pointed pages have been deleted or moved and these links
>> have not been updated.
>>> 
>>> 
>>> I suspect it has to do with how/where those HTMLs got generated. Because
>> in the latest-milestone live ones, I see them as links on this page
>> https://ant.apache.org/ivy/history/latest-milestone/index.html <https://ant.apache.org/ivy/history/latest-milestone/index.html>
<
>> https://ant.apache.org/ivy/history/latest-milestone/index.html <https://ant.apache.org/ivy/history/latest-milestone/index.html>>
>> 
>> Good catch.
>> Then the links should be absolute since they are not referencing something
>> within the doc.
>> 
>> Nicolas


Mime
  • Unnamed multipart/alternative (inline, None, 0 bytes)
View raw message