Re: Ivy - we have now moved to asciidoc for docs

[Nicolas Lalevée]

> 
> I’m now pick up the “Tutorials” section. 
> 
> 

I’ll take care of the last pages, "Reference/Introduction" and "Developper doc".

Nicolas


-
To unsubscribe, e-mail: dev-unsubscr...@ant.apache.org
For additional commands, e-mail: dev-h...@ant.apache.org

Re: Ivy - we have now moved to asciidoc for docs

[Nicolas Lalevée]

> Le 2 juil. 2017 à 07:23, Gintautas Grigelionis  a 
> écrit :
> 
> 2017-07-01 18:56 GMT+02:00 Nicolas Lalevée  >:
> 
>> 
>>> Le 1 juil. 2017 à 15:27, Gintautas Grigelionis 
>> a écrit :
>>> 
 Probably a thing to improve are all the « since 2.x » annotations. Maybe
>>> we can have a macro for that, which will render everywhere the same, and
>>> which will be placed everywhere the same. Now sometimes it is at the
>>> beginning of the line, sometimes at the end, sometimes above. And I find
>> it
>>> being black bold a little too much.
>>> 
>>> Isn't that what CSS is for? ".ivy2x:before", anyone?
>> 
>> The thing is that we need to put at least some marker in the source. I
>> don’t know if this is possible for a paragraph.
>> 
> 
> [ivy2x]#paragraph# ?
> 
> 
>> And the « since » is used in different situation. Sometimes it is about
>> the whole page, sometimes about a feature in the page, sometimes about an
>> option (rendered as a row in a table). Might be difficult to do in CSS. But
>> if there is a working patch, I would be happy to apply it.
>> 
> 
> For starters, can we decide whether "since 2.x" should be enclosed in
> parentheses everywhere and whether the parentheses should be italicised?

Whatever we decide, if we have an automated way to generate it, then we can 
change it later.

> P.S. I'm planing to work on generics in core, then tackle SVG.
>> Otherwise, I
>>> can just push the new Ivy logo in SVG, so everybody could get used to the
>>> not-so-limbless ant :-)
>> 
>> The doc of the master branch is already using the SVG logo of Ant, and it
>> is shining on my high def screen.
> 
> 
> So you notice the contrast with the adjacent Ivy logo? :-) There are more
> SVGs waiting to be used, and, by the way, how about using SVGs/fonts in the
> navigation column (open/closed/bullet)?

I have no objection.

Nicolas

Re: Ivy - we have now moved to asciidoc for docs

[Gintautas Grigelionis]

2017-07-01 18:56 GMT+02:00 Nicolas Lalevée :

>
> > Le 1 juil. 2017 à 15:27, Gintautas Grigelionis 
> a écrit :
> >
> >> Probably a thing to improve are all the « since 2.x » annotations. Maybe
> > we can have a macro for that, which will render everywhere the same, and
> > which will be placed everywhere the same. Now sometimes it is at the
> > beginning of the line, sometimes at the end, sometimes above. And I find
> it
> > being black bold a little too much.
> >
> > Isn't that what CSS is for? ".ivy2x:before", anyone?
>
> The thing is that we need to put at least some marker in the source. I
> don’t know if this is possible for a paragraph.
>

[ivy2x]#paragraph# ?


> And the « since » is used in different situation. Sometimes it is about
> the whole page, sometimes about a feature in the page, sometimes about an
> option (rendered as a row in a table). Might be difficult to do in CSS. But
> if there is a working patch, I would be happy to apply it.
>

For starters, can we decide whether "since 2.x" should be enclosed in
parentheses everywhere and whether the parentheses should be italicised?


> > P.S. I'm planing to work on generics in core, then tackle SVG.
> Otherwise, I
> > can just push the new Ivy logo in SVG, so everybody could get used to the
> > not-so-limbless ant :-)
>
> The doc of the master branch is already using the SVG logo of Ant, and it
> is shining on my high def screen.


So you notice the contrast with the adjacent Ivy logo? :-) There are more
SVGs waiting to be used, and, by the way, how about using SVGs/fonts in the
navigation column (open/closed/bullet)?

Gintas

Re: Ivy - we have now moved to asciidoc for docs

[Nicolas Lalevée]

> Le 1 juil. 2017 à 15:27, Gintautas Grigelionis  a 
> écrit :
> 
>> Probably a thing to improve are all the « since 2.x » annotations. Maybe
> we can have a macro for that, which will render everywhere the same, and
> which will be placed everywhere the same. Now sometimes it is at the
> beginning of the line, sometimes at the end, sometimes above. And I find it
> being black bold a little too much.
> 
> Isn't that what CSS is for? ".ivy2x:before", anyone?

The thing is that we need to put at least some marker in the source. I don’t 
know if this is possible for a paragraph.

And the « since » is used in different situation. Sometimes it is about the 
whole page, sometimes about a feature in the page, sometimes about an option 
(rendered as a row in a table). Might be difficult to do in CSS. But if there 
is a working patch, I would be happy to apply it.

> P.S. I'm planing to work on generics in core, then tackle SVG. Otherwise, I
> can just push the new Ivy logo in SVG, so everybody could get used to the
> not-so-limbless ant :-)

The doc of the master branch is already using the SVG logo of Ant, and it is 
shining on my high def screen.

Nicolas


-
To unsubscribe, e-mail: dev-unsubscr...@ant.apache.org
For additional commands, e-mail: dev-h...@ant.apache.org

Re: Ivy - we have now moved to asciidoc for docs

[Nicolas Lalevée]

> Le 1 juil. 2017 à 15:31, Jaikiran Pai  a écrit :
> 
> 
> On 29-Jun-2017, at 11:29 AM, Jaikiran Pai  wrote:
> 
> 
>> I’m picking up “OSGi” section next.
> 
> I have completed and pushed the migration of “OSGi” and “Using standalone” 
> sections to upstream (it’s actually live on site since yesterday). For the 
> OSGi pages, I had to reword some of the content to fix the grammar of some of 
> the sections. Also, there were a few outdated links to external projects, 
> that I had to point to new locations. One such link is the “bnd” tool link. 
> Our earlier doc here[1] points to [2] as the “bnd” tool but that link is no 
> longer live. I updated the docs to point it to [3] but I haven’t yet verified 
> that the example being explained in that page works with this tool. In fact, 
> I’m not 100% sure this new bndtools project is the same the bnd tool since 
> the project page says it’s “based” on that older tool. Either way, I’ll have 
> to verify it later that that example works fine.

BndTools is the Eclipse plugin for Bnd. I guess the teams became so close that 
they join. Seems that the new link is this one:
http://bnd.bndtools.org/ 

Nicolas

Re: Ivy - we have now moved to asciidoc for docs

[Jaikiran Pai]

On 29-Jun-2017, at 11:29 AM, Jaikiran Pai  wrote:


> I’m picking up “OSGi” section next.

I have completed and pushed the migration of “OSGi” and “Using standalone” 
sections to upstream (it’s actually live on site since yesterday). For the OSGi 
pages, I had to reword some of the content to fix the grammar of some of the 
sections. Also, there were a few outdated links to external projects, that I 
had to point to new locations. One such link is the “bnd” tool link. Our 
earlier doc here[1] points to [2] as the “bnd” tool but that link is no longer 
live. I updated the docs to point it to [3] but I haven’t yet verified that the 
example being explained in that page works with this tool. In fact, I’m not 
100% sure this new bndtools project is the same the bnd tool since the project 
page says it’s “based” on that older tool. Either way, I’ll have to verify it 
later that that example works fine.

I’m now pick up the “Tutorials” section. 


[1] https://ant.apache.org/ivy/history/latest-milestone/osgi/standard-osgi.html
[2] http://www.aqute.biz/Code/Bnd
[3] http://bndtools.org/

-Jaikiran
-
To unsubscribe, e-mail: dev-unsubscr...@ant.apache.org
For additional commands, e-mail: dev-h...@ant.apache.org

Re: Ivy - we have now moved to asciidoc for docs

[Gintautas Grigelionis]

> Probably a thing to improve are all the « since 2.x » annotations. Maybe
we can have a macro for that, which will render everywhere the same, and
which will be placed everywhere the same. Now sometimes it is at the
beginning of the line, sometimes at the end, sometimes above. And I find it
being black bold a little too much.

Isn't that what CSS is for? ".ivy2x:before", anyone?

Gintas

P.S. I'm planing to work on generics in core, then tackle SVG. Otherwise, I
can just push the new Ivy logo in SVG, so everybody could get used to the
not-so-limbless ant :-)

Re: Ivy - we have now moved to asciidoc for docs

[Gintautas Grigelionis]

Thank you. PR 49 and 50 became one big spaghetti as I tried to catch up
with your work and learn the ropes :-)
Now, 49 is closed and 50 is squashed.

Cheers,
Gintas

2017-07-01 14:07 GMT+02:00 Nicolas Lalevée :

> Thank you very much Gintas.
>
> These PRs are huge, so they will take a little bit of time to process.
>
> Also, in the PR 49 and 50 I can see a lot of commits [1] [2]. For a
> cleaner git history, could you rebase and squash them ? I don’t require to
> have one commit, for instance having the two commits in PR 48 is great. But
> in these two other PR, it seems a little bit noisy.
> And does PR 50 depends on PR 49 ? I can see commits from one included in
> the other.
>
> I bet these « noisy » commits are due to the conflicts generated by other
> commits. We can avoid these conflicts, and also avoid the work for you to
> resolve them: just tell us that you have some large commit incoming, and we
> will try to not modify much what you are working on.
>
> Cheers,
> Nicolas
>
> [1] https://github.com/apache/ant-ivy/pull/49/commits <
> https://github.com/apache/ant-ivy/pull/49/commits>
> [2] https://github.com/apache/ant-ivy/pull/50/commits <
> https://github.com/apache/ant-ivy/pull/50/commits>
>
> > Le 1 juil. 2017 à 08:07, Gintautas Grigelionis 
> a écrit :
> >
> > I opened a PR (well, actually two :-() to fix spelling and links that
> still
> > point to configuration.
> >
> > Gintas
> >
> > 2017-06-30 18:44 GMT+02:00 Gintautas Grigelionis <
> g.grigelio...@gmail.com>:
> >
> >> terminology.adoc apparently has an incorrect link on line 150,
> >> configuration/statuses.html should be settings/statuses.html
> >> (I get a redirect from http://ant.apache.org/ivy/
> >> history/master/terminology.html)
> >>
> >> Gintas
> >>
> >> 2017-06-30 18:18 GMT+02:00 Nicolas Lalevée  >:
> >>
> >>> I have seen that you have qualified the source blocks, telling it is
> xml.
> >>> Then I have done the same for the 'Ivy File' and 'Ant Tasks’ sections.
> And
> >>> I enabled the highlightjs integration with acsiidoctor. I don’t find
> the
> >>> default theme that cute (too lazy to search another one), but it is
> nicer
> >>> than nothing :)
> >>> I also seen some extended use of ‘code’ formatting, using ` in the
> >>> asciidoc files. So I have done as well on the sections I have worked
> on.
> >>> And I have put a little gray background color to improve the result. I
> hope
> >>> it is not too invasive.
> >>>
> >>> You can see the result on the site.
> >>>
> >>> Probably a thing to improve are all the « since 2.x » annotations.
> Maybe
> >>> we can have a macro for that, which will render everywhere the same,
> and
> >>> which will be placed everywhere the same. Now sometimes it is at the
> >>> beginning of the line, sometimes at the end, sometimes above. And I
> find it
> >>> being black bold a little too much.
> >>>
> >>> Nicolas
> >>>
>  Le 29 juin 2017 à 15:16, Jaikiran Pai  a
> >>> écrit :
> 
> 
>  On 29-Jun-2017, at 3:58 PM, Nicolas Lalevée <
> nicolas.lale...@hibnet.org>
> >>> wrote:
> 
> >
> >> Le 29 juin 2017 à 07:59, Jaikiran Pai  a
> >>> écrit :
> >>
> >> A quick update on this one - I finished off the “settings” sections
> >>> last week. There is only one pending item that I’m trying to address in
> >>> that section. The “Settings” page[1] has a “Settings File Structure”
> >>> section which tries to represent the Ivy settings XML file structure
> as a
> >>> tree. We have a similar one, one place else too (in Ivy file page). We
> use
> >>> a source code block to represent it. However, Asciidoc source code
> blocks
> >>> are rendered literally, so it won’t show up the links (as you’ll see in
> >>> that page[1] currently). For the Ivy page, I used “lists” to render the
> >>> structure and that was “good enough"[2]. However, I can’t use the same
> here
> >>> since Asciidoc (backed by asciidoctor generator) allows a max list
> depth of
> >>> 5 which means that any nested elements that exceed that depth won’t be
> >>> rendered correctly as a tree. The settings file structure goes beyond
> that
> >>> depth limit so it doesn’t work out well here.
> >>
> >> Ultimately, we either have to remove that section (there’s already a
> >>> “Child elements” section which _almost_ conveys the same thing) or
> come up
> >>> with a custom asciidoc “tree” kind of block element to render this. Any
> >>> thoughts?
> >
> > If I count correctly, there are 6 levels. So could we just remove the
> >>> root element from the tree so we save one level ? The root would be
> just
> >>> printed as some text. Could it then display correctly ?
> >
> 
>  That suggestion actually worked well. I went ahead and did that change
> >>> and regenerated the latest “master” site. It looks good
> >>> http://ant.apache.org/ivy/history/master/settings.html.
> 
> 

Re: Ivy - we have now moved to asciidoc for docs

[Jaikiran Pai]

On 30-Jun-2017, at 9:48 PM, Nicolas Lalevée  wrote:

> I have seen that you have qualified the source blocks, telling it is xml. 
> Then I have done the same for the 'Ivy File' and 'Ant Tasks’ sections. And I 
> enabled the highlightjs integration with acsiidoctor. I don’t find the 
> default theme that cute (too lazy to search another one), but it is nicer 
> than nothing :)

Thanks! Agreed that the style can be improved, but as you say, it’s better than 
the bland gray background we had for such blocks earlier.

> I also seen some extended use of ‘code’ formatting, using ` in the asciidoc 
> files. So I have done as well on the sections I have worked on. And I have 
> put a little gray background color to improve the result. I hope it is not 
> too invasive.

I actually find this change an improvement. Earlier, although such text did 
appear a bit different, it still wasn’t distinguished enough and I sometimes 
(depending on the browser/font size) had to really focus hard to distinguish it 
from regular text.

> Probably a thing to improve are all the « since 2.x » annotations. Maybe we 
> can have a macro for that, which will render everywhere the same, and which 
> will be placed everywhere the same. Now sometimes it is at the beginning of 
> the line, sometimes at the end, sometimes above. And I find it being black 
> bold a little too much.

Agreed. Maybe we could do something similar with the “experimental” 
note/section that we repeat (copy/paste really) on our OSGi pages.

-Jaikiran

> Le 29 juin 2017 à 15:16, Jaikiran Pai  a écrit :
> 
> 
> On 29-Jun-2017, at 3:58 PM, Nicolas Lalevée  
> wrote:
> 
>> 
>>> Le 29 juin 2017 à 07:59, Jaikiran Pai  a écrit :
>>> 
>>> A quick update on this one - I finished off the “settings” sections last 
>>> week. There is only one pending item that I’m trying to address in that 
>>> section. The “Settings” page[1] has a “Settings File Structure” section 
>>> which tries to represent the Ivy settings XML file structure as a tree. We 
>>> have a similar one, one place else too (in Ivy file page). We use a source 
>>> code block to represent it. However, Asciidoc source code blocks are 
>>> rendered literally, so it won’t show up the links (as you’ll see in that 
>>> page[1] currently). For the Ivy page, I used “lists” to render the 
>>> structure and that was “good enough"[2]. However, I can’t use the same here 
>>> since Asciidoc (backed by asciidoctor generator) allows a max list depth of 
>>> 5 which means that any nested elements that exceed that depth won’t be 
>>> rendered correctly as a tree. The settings file structure goes beyond that 
>>> depth limit so it doesn’t work out well here.
>>> 
>>> Ultimately, we either have to remove that section (there’s already a “Child 
>>> elements” section which _almost_ conveys the same thing) or come up with a 
>>> custom asciidoc “tree” kind of block element to render this. Any thoughts?
>> 
>> If I count correctly, there are 6 levels. So could we just remove the root 
>> element from the tree so we save one level ? The root would be just printed 
>> as some text. Could it then display correctly ?
>> 
> 
> That suggestion actually worked well. I went ahead and did that change and 
> regenerated the latest “master” site. It looks good 
> http://ant.apache.org/ivy/history/master/settings.html.
> 
> -Jaikiran
> 
> 
> 
> -
> To unsubscribe, e-mail: dev-unsubscr...@ant.apache.org
> For additional commands, e-mail: dev-h...@ant.apache.org
> 


-
To unsubscribe, e-mail: dev-unsubscr...@ant.apache.org
For additional commands, e-mail: dev-h...@ant.apache.org



-
To unsubscribe, e-mail: dev-unsubscr...@ant.apache.org
For additional commands, e-mail: dev-h...@ant.apache.org

Re: Ivy - we have now moved to asciidoc for docs

[Jaikiran Pai]

FWIW - I just finished reviewing PR-48 (the generics changes) 
https://github.com/apache/ant-ivy/pull/48/. Took me around an hour, the changes 
look fine :) I just have one comment/question about one of the change in that 
PR (I have to read up the Java spec or find some necessary documentation for 
it) https://github.com/apache/ant-ivy/pull/48#discussion-diff-125161935R162. 
Other than that, the PR looks fine to me.

-Jaikiran 
On 01-Jul-2017, at 5:37 PM, Nicolas Lalevée  wrote:

Thank you very much Gintas.

These PRs are huge, so they will take a little bit of time to process.

Also, in the PR 49 and 50 I can see a lot of commits [1] [2]. For a cleaner git 
history, could you rebase and squash them ? I don’t require to have one commit, 
for instance having the two commits in PR 48 is great. But in these two other 
PR, it seems a little bit noisy.
And does PR 50 depends on PR 49 ? I can see commits from one included in the 
other.

I bet these « noisy » commits are due to the conflicts generated by other 
commits. We can avoid these conflicts, and also avoid the work for you to 
resolve them: just tell us that you have some large commit incoming, and we 
will try to not modify much what you are working on.

Cheers,
Nicolas

[1] https://github.com/apache/ant-ivy/pull/49/commits 

[2] https://github.com/apache/ant-ivy/pull/50/commits 


> Le 1 juil. 2017 à 08:07, Gintautas Grigelionis  a 
> écrit :
> 
> I opened a PR (well, actually two :-() to fix spelling and links that still
> point to configuration.
> 
> Gintas
> 
> 2017-06-30 18:44 GMT+02:00 Gintautas Grigelionis :
> 
>> terminology.adoc apparently has an incorrect link on line 150,
>> configuration/statuses.html should be settings/statuses.html
>> (I get a redirect from http://ant.apache.org/ivy/
>> history/master/terminology.html)
>> 
>> Gintas
>> 
>> 2017-06-30 18:18 GMT+02:00 Nicolas Lalevée :
>> 
>>> I have seen that you have qualified the source blocks, telling it is xml.
>>> Then I have done the same for the 'Ivy File' and 'Ant Tasks’ sections. And
>>> I enabled the highlightjs integration with acsiidoctor. I don’t find the
>>> default theme that cute (too lazy to search another one), but it is nicer
>>> than nothing :)
>>> I also seen some extended use of ‘code’ formatting, using ` in the
>>> asciidoc files. So I have done as well on the sections I have worked on.
>>> And I have put a little gray background color to improve the result. I hope
>>> it is not too invasive.
>>> 
>>> You can see the result on the site.
>>> 
>>> Probably a thing to improve are all the « since 2.x » annotations. Maybe
>>> we can have a macro for that, which will render everywhere the same, and
>>> which will be placed everywhere the same. Now sometimes it is at the
>>> beginning of the line, sometimes at the end, sometimes above. And I find it
>>> being black bold a little too much.
>>> 
>>> Nicolas
>>> 
 Le 29 juin 2017 à 15:16, Jaikiran Pai  a
>>> écrit :
 
 
 On 29-Jun-2017, at 3:58 PM, Nicolas Lalevée 
>>> wrote:
 
> 
>> Le 29 juin 2017 à 07:59, Jaikiran Pai  a
>>> écrit :
>> 
>> A quick update on this one - I finished off the “settings” sections
>>> last week. There is only one pending item that I’m trying to address in
>>> that section. The “Settings” page[1] has a “Settings File Structure”
>>> section which tries to represent the Ivy settings XML file structure as a
>>> tree. We have a similar one, one place else too (in Ivy file page). We use
>>> a source code block to represent it. However, Asciidoc source code blocks
>>> are rendered literally, so it won’t show up the links (as you’ll see in
>>> that page[1] currently). For the Ivy page, I used “lists” to render the
>>> structure and that was “good enough"[2]. However, I can’t use the same here
>>> since Asciidoc (backed by asciidoctor generator) allows a max list depth of
>>> 5 which means that any nested elements that exceed that depth won’t be
>>> rendered correctly as a tree. The settings file structure goes beyond that
>>> depth limit so it doesn’t work out well here.
>> 
>> Ultimately, we either have to remove that section (there’s already a
>>> “Child elements” section which _almost_ conveys the same thing) or come up
>>> with a custom asciidoc “tree” kind of block element to render this. Any
>>> thoughts?
> 
> If I count correctly, there are 6 levels. So could we just remove the
>>> root element from the tree so we save one level ? The root would be just
>>> printed as some text. Could it then display correctly ?
> 
 
 That suggestion actually worked well. I went ahead and did that change
>>> and regenerated the latest “master” site. It looks good
>>> 

Re: Ivy - we have now moved to asciidoc for docs

[Nicolas Lalevée]

Thank you very much Gintas.

These PRs are huge, so they will take a little bit of time to process.

Also, in the PR 49 and 50 I can see a lot of commits [1] [2]. For a cleaner git 
history, could you rebase and squash them ? I don’t require to have one commit, 
for instance having the two commits in PR 48 is great. But in these two other 
PR, it seems a little bit noisy.
And does PR 50 depends on PR 49 ? I can see commits from one included in the 
other.

I bet these « noisy » commits are due to the conflicts generated by other 
commits. We can avoid these conflicts, and also avoid the work for you to 
resolve them: just tell us that you have some large commit incoming, and we 
will try to not modify much what you are working on.

Cheers,
Nicolas

[1] https://github.com/apache/ant-ivy/pull/49/commits 

[2] https://github.com/apache/ant-ivy/pull/50/commits 


> Le 1 juil. 2017 à 08:07, Gintautas Grigelionis  a 
> écrit :
> 
> I opened a PR (well, actually two :-() to fix spelling and links that still
> point to configuration.
> 
> Gintas
> 
> 2017-06-30 18:44 GMT+02:00 Gintautas Grigelionis :
> 
>> terminology.adoc apparently has an incorrect link on line 150,
>> configuration/statuses.html should be settings/statuses.html
>> (I get a redirect from http://ant.apache.org/ivy/
>> history/master/terminology.html)
>> 
>> Gintas
>> 
>> 2017-06-30 18:18 GMT+02:00 Nicolas Lalevée :
>> 
>>> I have seen that you have qualified the source blocks, telling it is xml.
>>> Then I have done the same for the 'Ivy File' and 'Ant Tasks’ sections. And
>>> I enabled the highlightjs integration with acsiidoctor. I don’t find the
>>> default theme that cute (too lazy to search another one), but it is nicer
>>> than nothing :)
>>> I also seen some extended use of ‘code’ formatting, using ` in the
>>> asciidoc files. So I have done as well on the sections I have worked on.
>>> And I have put a little gray background color to improve the result. I hope
>>> it is not too invasive.
>>> 
>>> You can see the result on the site.
>>> 
>>> Probably a thing to improve are all the « since 2.x » annotations. Maybe
>>> we can have a macro for that, which will render everywhere the same, and
>>> which will be placed everywhere the same. Now sometimes it is at the
>>> beginning of the line, sometimes at the end, sometimes above. And I find it
>>> being black bold a little too much.
>>> 
>>> Nicolas
>>> 
 Le 29 juin 2017 à 15:16, Jaikiran Pai  a
>>> écrit :
 
 
 On 29-Jun-2017, at 3:58 PM, Nicolas Lalevée 
>>> wrote:
 
> 
>> Le 29 juin 2017 à 07:59, Jaikiran Pai  a
>>> écrit :
>> 
>> A quick update on this one - I finished off the “settings” sections
>>> last week. There is only one pending item that I’m trying to address in
>>> that section. The “Settings” page[1] has a “Settings File Structure”
>>> section which tries to represent the Ivy settings XML file structure as a
>>> tree. We have a similar one, one place else too (in Ivy file page). We use
>>> a source code block to represent it. However, Asciidoc source code blocks
>>> are rendered literally, so it won’t show up the links (as you’ll see in
>>> that page[1] currently). For the Ivy page, I used “lists” to render the
>>> structure and that was “good enough"[2]. However, I can’t use the same here
>>> since Asciidoc (backed by asciidoctor generator) allows a max list depth of
>>> 5 which means that any nested elements that exceed that depth won’t be
>>> rendered correctly as a tree. The settings file structure goes beyond that
>>> depth limit so it doesn’t work out well here.
>> 
>> Ultimately, we either have to remove that section (there’s already a
>>> “Child elements” section which _almost_ conveys the same thing) or come up
>>> with a custom asciidoc “tree” kind of block element to render this. Any
>>> thoughts?
> 
> If I count correctly, there are 6 levels. So could we just remove the
>>> root element from the tree so we save one level ? The root would be just
>>> printed as some text. Could it then display correctly ?
> 
 
 That suggestion actually worked well. I went ahead and did that change
>>> and regenerated the latest “master” site. It looks good
>>> http://ant.apache.org/ivy/history/master/settings.html.
 
 -Jaikiran
 
 
 
 -
 To unsubscribe, e-mail: dev-unsubscr...@ant.apache.org
 For additional commands, e-mail: dev-h...@ant.apache.org
 
>>> 
>>> 
>>> -
>>> To unsubscribe, e-mail: dev-unsubscr...@ant.apache.org
>>> For additional commands, e-mail: dev-h...@ant.apache.org
>>> 
>>> 
>> 

Re: Ivy - we have now moved to asciidoc for docs

[Gintautas Grigelionis]

I opened a PR (well, actually two :-() to fix spelling and links that still
point to configuration.

Gintas

2017-06-30 18:44 GMT+02:00 Gintautas Grigelionis :

> terminology.adoc apparently has an incorrect link on line 150,
> configuration/statuses.html should be settings/statuses.html
> (I get a redirect from http://ant.apache.org/ivy/
> history/master/terminology.html)
>
> Gintas
>
> 2017-06-30 18:18 GMT+02:00 Nicolas Lalevée :
>
>> I have seen that you have qualified the source blocks, telling it is xml.
>> Then I have done the same for the 'Ivy File' and 'Ant Tasks’ sections. And
>> I enabled the highlightjs integration with acsiidoctor. I don’t find the
>> default theme that cute (too lazy to search another one), but it is nicer
>> than nothing :)
>> I also seen some extended use of ‘code’ formatting, using ` in the
>> asciidoc files. So I have done as well on the sections I have worked on.
>> And I have put a little gray background color to improve the result. I hope
>> it is not too invasive.
>>
>> You can see the result on the site.
>>
>> Probably a thing to improve are all the « since 2.x » annotations. Maybe
>> we can have a macro for that, which will render everywhere the same, and
>> which will be placed everywhere the same. Now sometimes it is at the
>> beginning of the line, sometimes at the end, sometimes above. And I find it
>> being black bold a little too much.
>>
>> Nicolas
>>
>> > Le 29 juin 2017 à 15:16, Jaikiran Pai  a
>> écrit :
>> >
>> >
>> > On 29-Jun-2017, at 3:58 PM, Nicolas Lalevée 
>> wrote:
>> >
>> >>
>> >>> Le 29 juin 2017 à 07:59, Jaikiran Pai  a
>> écrit :
>> >>>
>> >>> A quick update on this one - I finished off the “settings” sections
>> last week. There is only one pending item that I’m trying to address in
>> that section. The “Settings” page[1] has a “Settings File Structure”
>> section which tries to represent the Ivy settings XML file structure as a
>> tree. We have a similar one, one place else too (in Ivy file page). We use
>> a source code block to represent it. However, Asciidoc source code blocks
>> are rendered literally, so it won’t show up the links (as you’ll see in
>> that page[1] currently). For the Ivy page, I used “lists” to render the
>> structure and that was “good enough"[2]. However, I can’t use the same here
>> since Asciidoc (backed by asciidoctor generator) allows a max list depth of
>> 5 which means that any nested elements that exceed that depth won’t be
>> rendered correctly as a tree. The settings file structure goes beyond that
>> depth limit so it doesn’t work out well here.
>> >>>
>> >>> Ultimately, we either have to remove that section (there’s already a
>> “Child elements” section which _almost_ conveys the same thing) or come up
>> with a custom asciidoc “tree” kind of block element to render this. Any
>> thoughts?
>> >>
>> >> If I count correctly, there are 6 levels. So could we just remove the
>> root element from the tree so we save one level ? The root would be just
>> printed as some text. Could it then display correctly ?
>> >>
>> >
>> > That suggestion actually worked well. I went ahead and did that change
>> and regenerated the latest “master” site. It looks good
>> http://ant.apache.org/ivy/history/master/settings.html.
>> >
>> > -Jaikiran
>> >
>> >
>> >
>> > -
>> > To unsubscribe, e-mail: dev-unsubscr...@ant.apache.org
>> > For additional commands, e-mail: dev-h...@ant.apache.org
>> >
>>
>>
>> -
>> To unsubscribe, e-mail: dev-unsubscr...@ant.apache.org
>> For additional commands, e-mail: dev-h...@ant.apache.org
>>
>>
>

Re: Ivy - we have now moved to asciidoc for docs

[Gintautas Grigelionis]

terminology.adoc apparently has an incorrect link on line 150,
configuration/statuses.html should be settings/statuses.html
(I get a redirect from
http://ant.apache.org/ivy/history/master/terminology.html)

Gintas

2017-06-30 18:18 GMT+02:00 Nicolas Lalevée :

> I have seen that you have qualified the source blocks, telling it is xml.
> Then I have done the same for the 'Ivy File' and 'Ant Tasks’ sections. And
> I enabled the highlightjs integration with acsiidoctor. I don’t find the
> default theme that cute (too lazy to search another one), but it is nicer
> than nothing :)
> I also seen some extended use of ‘code’ formatting, using ` in the
> asciidoc files. So I have done as well on the sections I have worked on.
> And I have put a little gray background color to improve the result. I hope
> it is not too invasive.
>
> You can see the result on the site.
>
> Probably a thing to improve are all the « since 2.x » annotations. Maybe
> we can have a macro for that, which will render everywhere the same, and
> which will be placed everywhere the same. Now sometimes it is at the
> beginning of the line, sometimes at the end, sometimes above. And I find it
> being black bold a little too much.
>
> Nicolas
>
> > Le 29 juin 2017 à 15:16, Jaikiran Pai  a
> écrit :
> >
> >
> > On 29-Jun-2017, at 3:58 PM, Nicolas Lalevée 
> wrote:
> >
> >>
> >>> Le 29 juin 2017 à 07:59, Jaikiran Pai  a
> écrit :
> >>>
> >>> A quick update on this one - I finished off the “settings” sections
> last week. There is only one pending item that I’m trying to address in
> that section. The “Settings” page[1] has a “Settings File Structure”
> section which tries to represent the Ivy settings XML file structure as a
> tree. We have a similar one, one place else too (in Ivy file page). We use
> a source code block to represent it. However, Asciidoc source code blocks
> are rendered literally, so it won’t show up the links (as you’ll see in
> that page[1] currently). For the Ivy page, I used “lists” to render the
> structure and that was “good enough"[2]. However, I can’t use the same here
> since Asciidoc (backed by asciidoctor generator) allows a max list depth of
> 5 which means that any nested elements that exceed that depth won’t be
> rendered correctly as a tree. The settings file structure goes beyond that
> depth limit so it doesn’t work out well here.
> >>>
> >>> Ultimately, we either have to remove that section (there’s already a
> “Child elements” section which _almost_ conveys the same thing) or come up
> with a custom asciidoc “tree” kind of block element to render this. Any
> thoughts?
> >>
> >> If I count correctly, there are 6 levels. So could we just remove the
> root element from the tree so we save one level ? The root would be just
> printed as some text. Could it then display correctly ?
> >>
> >
> > That suggestion actually worked well. I went ahead and did that change
> and regenerated the latest “master” site. It looks good
> http://ant.apache.org/ivy/history/master/settings.html.
> >
> > -Jaikiran
> >
> >
> >
> > -
> > To unsubscribe, e-mail: dev-unsubscr...@ant.apache.org
> > For additional commands, e-mail: dev-h...@ant.apache.org
> >
>
>
> -
> To unsubscribe, e-mail: dev-unsubscr...@ant.apache.org
> For additional commands, e-mail: dev-h...@ant.apache.org
>
>

Re: Ivy - we have now moved to asciidoc for docs

[Nicolas Lalevée]

I have seen that you have qualified the source blocks, telling it is xml. Then 
I have done the same for the 'Ivy File' and 'Ant Tasks’ sections. And I enabled 
the highlightjs integration with acsiidoctor. I don’t find the default theme 
that cute (too lazy to search another one), but it is nicer than nothing :)
I also seen some extended use of ‘code’ formatting, using ` in the asciidoc 
files. So I have done as well on the sections I have worked on. And I have put 
a little gray background color to improve the result. I hope it is not too 
invasive.

You can see the result on the site.

Probably a thing to improve are all the « since 2.x » annotations. Maybe we can 
have a macro for that, which will render everywhere the same, and which will be 
placed everywhere the same. Now sometimes it is at the beginning of the line, 
sometimes at the end, sometimes above. And I find it being black bold a little 
too much.

Nicolas

> Le 29 juin 2017 à 15:16, Jaikiran Pai  a écrit :
> 
> 
> On 29-Jun-2017, at 3:58 PM, Nicolas Lalevée  
> wrote:
> 
>> 
>>> Le 29 juin 2017 à 07:59, Jaikiran Pai  a écrit :
>>> 
>>> A quick update on this one - I finished off the “settings” sections last 
>>> week. There is only one pending item that I’m trying to address in that 
>>> section. The “Settings” page[1] has a “Settings File Structure” section 
>>> which tries to represent the Ivy settings XML file structure as a tree. We 
>>> have a similar one, one place else too (in Ivy file page). We use a source 
>>> code block to represent it. However, Asciidoc source code blocks are 
>>> rendered literally, so it won’t show up the links (as you’ll see in that 
>>> page[1] currently). For the Ivy page, I used “lists” to render the 
>>> structure and that was “good enough"[2]. However, I can’t use the same here 
>>> since Asciidoc (backed by asciidoctor generator) allows a max list depth of 
>>> 5 which means that any nested elements that exceed that depth won’t be 
>>> rendered correctly as a tree. The settings file structure goes beyond that 
>>> depth limit so it doesn’t work out well here.
>>> 
>>> Ultimately, we either have to remove that section (there’s already a “Child 
>>> elements” section which _almost_ conveys the same thing) or come up with a 
>>> custom asciidoc “tree” kind of block element to render this. Any thoughts?
>> 
>> If I count correctly, there are 6 levels. So could we just remove the root 
>> element from the tree so we save one level ? The root would be just printed 
>> as some text. Could it then display correctly ?
>> 
> 
> That suggestion actually worked well. I went ahead and did that change and 
> regenerated the latest “master” site. It looks good 
> http://ant.apache.org/ivy/history/master/settings.html.
> 
> -Jaikiran
> 
> 
> 
> -
> To unsubscribe, e-mail: dev-unsubscr...@ant.apache.org
> For additional commands, e-mail: dev-h...@ant.apache.org
> 


-
To unsubscribe, e-mail: dev-unsubscr...@ant.apache.org
For additional commands, e-mail: dev-h...@ant.apache.org

Re: Ivy - we have now moved to asciidoc for docs

[Jaikiran Pai]

On 29-Jun-2017, at 3:58 PM, Nicolas Lalevée  wrote:

> 
>> Le 29 juin 2017 à 07:59, Jaikiran Pai  a écrit :
>> 
>> A quick update on this one - I finished off the “settings” sections last 
>> week. There is only one pending item that I’m trying to address in that 
>> section. The “Settings” page[1] has a “Settings File Structure” section 
>> which tries to represent the Ivy settings XML file structure as a tree. We 
>> have a similar one, one place else too (in Ivy file page). We use a source 
>> code block to represent it. However, Asciidoc source code blocks are 
>> rendered literally, so it won’t show up the links (as you’ll see in that 
>> page[1] currently). For the Ivy page, I used “lists” to render the structure 
>> and that was “good enough"[2]. However, I can’t use the same here since 
>> Asciidoc (backed by asciidoctor generator) allows a max list depth of 5 
>> which means that any nested elements that exceed that depth won’t be 
>> rendered correctly as a tree. The settings file structure goes beyond that 
>> depth limit so it doesn’t work out well here.
>> 
>> Ultimately, we either have to remove that section (there’s already a “Child 
>> elements” section which _almost_ conveys the same thing) or come up with a 
>> custom asciidoc “tree” kind of block element to render this. Any thoughts?
> 
> If I count correctly, there are 6 levels. So could we just remove the root 
> element from the tree so we save one level ? The root would be just printed 
> as some text. Could it then display correctly ?
> 

That suggestion actually worked well. I went ahead and did that change and 
regenerated the latest “master” site. It looks good 
http://ant.apache.org/ivy/history/master/settings.html.

-Jaikiran



-
To unsubscribe, e-mail: dev-unsubscr...@ant.apache.org
For additional commands, e-mail: dev-h...@ant.apache.org

Re: Ivy - we have now moved to asciidoc for docs

[Nicolas Lalevée]

> Le 29 juin 2017 à 07:59, Jaikiran Pai  a écrit :
> 
> A quick update on this one - I finished off the “settings” sections last 
> week. There is only one pending item that I’m trying to address in that 
> section. The “Settings” page[1] has a “Settings File Structure” section which 
> tries to represent the Ivy settings XML file structure as a tree. We have a 
> similar one, one place else too (in Ivy file page). We use a source code 
> block to represent it. However, Asciidoc source code blocks are rendered 
> literally, so it won’t show up the links (as you’ll see in that page[1] 
> currently). For the Ivy page, I used “lists” to render the structure and that 
> was “good enough"[2]. However, I can’t use the same here since Asciidoc 
> (backed by asciidoctor generator) allows a max list depth of 5 which means 
> that any nested elements that exceed that depth won’t be rendered correctly 
> as a tree. The settings file structure goes beyond that depth limit so it 
> doesn’t work out well here.
> 
> Ultimately, we either have to remove that section (there’s already a “Child 
> elements” section which _almost_ conveys the same thing) or come up with a 
> custom asciidoc “tree” kind of block element to render this. Any thoughts?

If I count correctly, there are 6 levels. So could we just remove the root 
element from the tree so we save one level ? The root would be just printed as 
some text. Could it then display correctly ?
If it is too weird, let’s remove that section; the tree is shown in the toc so 
I guess it is OK.

> By the way, I consider the settings section to be “done” in terms of 
> migration. If anyone however notices any discrepancies while doing a quick 
> review of the rendered pages, feel free to drop a mail.
> 
> I’m picking up “OSGi” section next.

And I have done the Ivy files, I’ll review the Ant Tasks section now.

Nicolas

> 
> [1] 
> https://builds.apache.org/view/A/view/Ant/job/Ivy-NightlyDistribution/lastSuccessfulBuild/artifact/build/doc/settings.html
> [2] See “Hierarchical Index” section at 
> https://builds.apache.org/view/A/view/Ant/job/Ivy-NightlyDistribution/lastSuccessfulBuild/artifact/build/doc/ivyfile.html
> 
> -Jaikiran
> 
> On 24-Jun-2017, at 7:18 PM, Nicolas Lalevée  
> wrote:
> 
>> 
>>> 
>>> And just an idea: since there are a lot of pages, maybe we could organize a 
>>> review at many, without useless double checks. I see 4 big parts in the 
>>> doc: the ant tasks, the pages related to the ivy file, the pages related to 
>>> the ivysettings, and the other pages. If 4 volunteers can do a quick review 
>>> of each page, I think we can be pretty confident that we didn’t leave any 
>>> ugliness somewhere. The goal wouldn’t to do a fine grain review, but ensure 
>>> that everything is readable. wdyt ?
>>> 
>> 
>> Sounds a good idea. I’ll start off with the “Settings” which relates to the 
>> Ivy settings file.
> 
> Great. I’ll take care of « Ivy Files ».
> 
> Nicolas
> 
> 
> -
> To unsubscribe, e-mail: dev-unsubscr...@ant.apache.org
> For additional commands, e-mail: dev-h...@ant.apache.org
> 
> 
> 
> -
> To unsubscribe, e-mail: dev-unsubscr...@ant.apache.org
> For additional commands, e-mail: dev-h...@ant.apache.org
> 


-
To unsubscribe, e-mail: dev-unsubscr...@ant.apache.org
For additional commands, e-mail: dev-h...@ant.apache.org

Re: Ivy - we have now moved to asciidoc for docs

[Jaikiran Pai]

A quick update on this one - I finished off the “settings” sections last week. 
There is only one pending item that I’m trying to address in that section. The 
“Settings” page[1] has a “Settings File Structure” section which tries to 
represent the Ivy settings XML file structure as a tree. We have a similar one, 
one place else too (in Ivy file page). We use a source code block to represent 
it. However, Asciidoc source code blocks are rendered literally, so it won’t 
show up the links (as you’ll see in that page[1] currently). For the Ivy page, 
I used “lists” to render the structure and that was “good enough"[2]. However, 
I can’t use the same here since Asciidoc (backed by asciidoctor generator) 
allows a max list depth of 5 which means that any nested elements that exceed 
that depth won’t be rendered correctly as a tree. The settings file structure 
goes beyond that depth limit so it doesn’t work out well here.

Ultimately, we either have to remove that section (there’s already a “Child 
elements” section which _almost_ conveys the same thing) or come up with a 
custom asciidoc “tree” kind of block element to render this. Any thoughts?

By the way, I consider the settings section to be “done” in terms of migration. 
If anyone however notices any discrepancies while doing a quick review of the 
rendered pages, feel free to drop a mail.

I’m picking up “OSGi” section next.

[1] 
https://builds.apache.org/view/A/view/Ant/job/Ivy-NightlyDistribution/lastSuccessfulBuild/artifact/build/doc/settings.html
[2] See “Hierarchical Index” section at 
https://builds.apache.org/view/A/view/Ant/job/Ivy-NightlyDistribution/lastSuccessfulBuild/artifact/build/doc/ivyfile.html

-Jaikiran

On 24-Jun-2017, at 7:18 PM, Nicolas Lalevée  wrote:

> 
>> 
>> And just an idea: since there are a lot of pages, maybe we could organize a 
>> review at many, without useless double checks. I see 4 big parts in the doc: 
>> the ant tasks, the pages related to the ivy file, the pages related to the 
>> ivysettings, and the other pages. If 4 volunteers can do a quick review of 
>> each page, I think we can be pretty confident that we didn’t leave any 
>> ugliness somewhere. The goal wouldn’t to do a fine grain review, but ensure 
>> that everything is readable. wdyt ?
>> 
> 
> Sounds a good idea. I’ll start off with the “Settings” which relates to the 
> Ivy settings file.

Great. I’ll take care of « Ivy Files ».

Nicolas


-
To unsubscribe, e-mail: dev-unsubscr...@ant.apache.org
For additional commands, e-mail: dev-h...@ant.apache.org



-
To unsubscribe, e-mail: dev-unsubscr...@ant.apache.org
For additional commands, e-mail: dev-h...@ant.apache.org

Re: Ivy - we have now moved to asciidoc for docs

[Nicolas Lalevée]

> 
>> 
>> And just an idea: since there are a lot of pages, maybe we could organize a 
>> review at many, without useless double checks. I see 4 big parts in the doc: 
>> the ant tasks, the pages related to the ivy file, the pages related to the 
>> ivysettings, and the other pages. If 4 volunteers can do a quick review of 
>> each page, I think we can be pretty confident that we didn’t leave any 
>> ugliness somewhere. The goal wouldn’t to do a fine grain review, but ensure 
>> that everything is readable. wdyt ?
>> 
> 
> Sounds a good idea. I’ll start off with the “Settings” which relates to the 
> Ivy settings file.

Great. I’ll take care of « Ivy Files ».

Nicolas


-
To unsubscribe, e-mail: dev-unsubscr...@ant.apache.org
For additional commands, e-mail: dev-h...@ant.apache.org

Re: Ivy - we have now moved to asciidoc for docs

[Gintautas Grigelionis]

I'd happy to help later tonight, please let me know if there's some
particular section that I should look into.
Skimming through quickly, More Examples (
http://people.apache.org/~hibou/doc/moreexamples.html) should be adjusted.

Gintas

2017-06-20 4:16 GMT+02:00 Jaikiran Pai :

> >
> > On 20-Jun-2017, at 3:38 AM, Nicolas Lalevée 
> wrote:
> >
> >
> >> Le 19 juin 2017 à 04:52, Jaikiran Pai  a
> écrit :
> >>
> >> The documentation for ant-ivy project has now been migrated to
> asciidoc. The migration used a tool developed by Nicolas to migrate the
> xooki backed HTML docs to asciidoc. This tool auto-generated the asciidoc
> text and for most part no other changes were needed. However, there are
> some fixes the generated asciidoc will need which I’m doing and will
> continue to do in the coming days to fix any issues with the generated doc.
> Once the fixes are done, soon, we’ll remove the xooki backed documentation
> completely from our git repo. For now though, any new documentation or
> changes should go into the asciidoc files.
> >
> > I did a general grep about finding non translated html markup, and I
> have cleaned the ones I have found.
> > I have pushed the result here: http://people.apache.org/~hibou/doc/ <
> http://people.apache.org/~hibou/doc/>
> >
> > Probably we can start pushing it to the site, since there is section
> dedicated to the trunk version of the doc (which should be probably renamed
> master).
> > http://ant.apache.org/ivy/history/trunk/index.html <
> http://ant.apache.org/ivy/history/trunk/index.html>
> > It would be an opportunity to get an idea of what would it mean when a
> release will happen.
>
> I actually forgot to send a mail yesterday, but I setup our nightly Ivy
> job on Jenkins to publish the latest generated docs as build artifact so
> that it gives everyone a chance to view/review it. It’s here
> https://builds.apache.org/view/A/view/Ant/job/Ivy-NightlyDistribution/
> lastSuccessfulBuild/artifact/build/. We could just push it to the site
> under master but I wasn’t too sure if it’s the right time to do that or if
> we should just cleanup the rest of the issues in the doc before starting to
> push it there.
>
> >
> > And just an idea: since there are a lot of pages, maybe we could
> organize a review at many, without useless double checks. I see 4 big parts
> in the doc: the ant tasks, the pages related to the ivy file, the pages
> related to the ivysettings, and the other pages. If 4 volunteers can do a
> quick review of each page, I think we can be pretty confident that we
> didn’t leave any ugliness somewhere. The goal wouldn’t to do a fine grain
> review, but ensure that everything is readable. wdyt ?
> >
>
> Sounds a good idea. I’ll start off with the “Settings” which relates to
> the Ivy settings file.
>
> -Jaikiran
>
>
>
> -
> To unsubscribe, e-mail: dev-unsubscr...@ant.apache.org
> For additional commands, e-mail: dev-h...@ant.apache.org
>
>

Re: Ivy - we have now moved to asciidoc for docs

[Jaikiran Pai]

> 
> On 20-Jun-2017, at 3:38 AM, Nicolas Lalevée  
> wrote:
> 
> 
>> Le 19 juin 2017 à 04:52, Jaikiran Pai  a écrit :
>> 
>> The documentation for ant-ivy project has now been migrated to asciidoc. The 
>> migration used a tool developed by Nicolas to migrate the xooki backed HTML 
>> docs to asciidoc. This tool auto-generated the asciidoc text and for most 
>> part no other changes were needed. However, there are some fixes the 
>> generated asciidoc will need which I’m doing and will continue to do in the 
>> coming days to fix any issues with the generated doc. Once the fixes are 
>> done, soon, we’ll remove the xooki backed documentation completely from our 
>> git repo. For now though, any new documentation or changes should go into 
>> the asciidoc files.
> 
> I did a general grep about finding non translated html markup, and I have 
> cleaned the ones I have found.
> I have pushed the result here: http://people.apache.org/~hibou/doc/ 
> 
> 
> Probably we can start pushing it to the site, since there is section 
> dedicated to the trunk version of the doc (which should be probably renamed 
> master).
> http://ant.apache.org/ivy/history/trunk/index.html 
> 
> It would be an opportunity to get an idea of what would it mean when a 
> release will happen.

I actually forgot to send a mail yesterday, but I setup our nightly Ivy job on 
Jenkins to publish the latest generated docs as build artifact so that it gives 
everyone a chance to view/review it. It’s here 
https://builds.apache.org/view/A/view/Ant/job/Ivy-NightlyDistribution/lastSuccessfulBuild/artifact/build/.
 We could just push it to the site under master but I wasn’t too sure if it’s 
the right time to do that or if we should just cleanup the rest of the issues 
in the doc before starting to push it there.

> 
> And just an idea: since there are a lot of pages, maybe we could organize a 
> review at many, without useless double checks. I see 4 big parts in the doc: 
> the ant tasks, the pages related to the ivy file, the pages related to the 
> ivysettings, and the other pages. If 4 volunteers can do a quick review of 
> each page, I think we can be pretty confident that we didn’t leave any 
> ugliness somewhere. The goal wouldn’t to do a fine grain review, but ensure 
> that everything is readable. wdyt ?
> 

Sounds a good idea. I’ll start off with the “Settings” which relates to the Ivy 
settings file.

-Jaikiran



-
To unsubscribe, e-mail: dev-unsubscr...@ant.apache.org
For additional commands, e-mail: dev-h...@ant.apache.org

Re: Ivy - we have now moved to asciidoc for docs

[Jaikiran Pai]

Yes, that appears to be the only place where we explain documentation 
contribution. 

However, the IvyDE project page too points to this page. That’s a reminder for 
us that the IvyDE project too probably needs to move to asciidoc.

-Jaikiran

On 20-Jun-2017, at 3:39 AM, Nicolas Lalevée  wrote:


> Le 19 juin 2017 à 08:30, Jan Matèrne (jhm)  a écrit :
> 
> Doc's mentioning 'how to document' must be updated.
> I found http://ant.apache.org/ivy/write-doc.html Some more?

This is the only page which explain xooki I know.

Nicolas

> 
> Jan
> 
>> -Ursprüngliche Nachricht-
>> Von: Jaikiran Pai [mailto:jai.forums2...@gmail.com]
>> Gesendet: Montag, 19. Juni 2017 04:52
>> An: Ant Developers List
>> Betreff: Ivy - we have now moved to asciidoc for docs
>> 
>> The documentation for ant-ivy project has now been migrated to
>> asciidoc. The migration used a tool developed by Nicolas to migrate the
>> xooki backed HTML docs to asciidoc. This tool auto-generated the
>> asciidoc text and for most part no other changes were needed. However,
>> there are some fixes the generated asciidoc will need which I’m doing
>> and will continue to do in the coming days to fix any issues with the
>> generated doc. Once the fixes are done, soon, we’ll remove the xooki
>> backed documentation completely from our git repo. For now though, any
>> new documentation or changes should go into the asciidoc files.
>> 
>> -Jaikiran
>> -
>> To unsubscribe, e-mail: dev-unsubscr...@ant.apache.org For additional
>> commands, e-mail: dev-h...@ant.apache.org
> 
> 
> 
> -
> To unsubscribe, e-mail: dev-unsubscr...@ant.apache.org
> For additional commands, e-mail: dev-h...@ant.apache.org
> 


-
To unsubscribe, e-mail: dev-unsubscr...@ant.apache.org
For additional commands, e-mail: dev-h...@ant.apache.org



-
To unsubscribe, e-mail: dev-unsubscr...@ant.apache.org
For additional commands, e-mail: dev-h...@ant.apache.org

Re: Ivy - we have now moved to asciidoc for docs

[Gintautas Grigelionis]

SVG is inlined as code, see http://people.apache.org/~hibou/doc/osgi.html

Gintas

2017-06-20 0:09 GMT+02:00 Nicolas Lalevée :

>
> > Le 19 juin 2017 à 08:30, Jan Matèrne (jhm)  a écrit :
> >
> > Doc's mentioning 'how to document' must be updated.
> > I found http://ant.apache.org/ivy/write-doc.html Some more?
>
> This is the only page which explain xooki I know.
>
> Nicolas
>
> >
> > Jan
> >
> >> -Ursprüngliche Nachricht-
> >> Von: Jaikiran Pai [mailto:jai.forums2...@gmail.com]
> >> Gesendet: Montag, 19. Juni 2017 04:52
> >> An: Ant Developers List
> >> Betreff: Ivy - we have now moved to asciidoc for docs
> >>
> >> The documentation for ant-ivy project has now been migrated to
> >> asciidoc. The migration used a tool developed by Nicolas to migrate the
> >> xooki backed HTML docs to asciidoc. This tool auto-generated the
> >> asciidoc text and for most part no other changes were needed. However,
> >> there are some fixes the generated asciidoc will need which I’m doing
> >> and will continue to do in the coming days to fix any issues with the
> >> generated doc. Once the fixes are done, soon, we’ll remove the xooki
> >> backed documentation completely from our git repo. For now though, any
> >> new documentation or changes should go into the asciidoc files.
> >>
> >> -Jaikiran
> >> -
> >> To unsubscribe, e-mail: dev-unsubscr...@ant.apache.org For additional
> >> commands, e-mail: dev-h...@ant.apache.org
> >
> >
> >
> > -
> > To unsubscribe, e-mail: dev-unsubscr...@ant.apache.org
> > For additional commands, e-mail: dev-h...@ant.apache.org
> >
>
>
> -
> To unsubscribe, e-mail: dev-unsubscr...@ant.apache.org
> For additional commands, e-mail: dev-h...@ant.apache.org
>
>

Re: Ivy - we have now moved to asciidoc for docs

[Nicolas Lalevée]

> Le 19 juin 2017 à 08:30, Jan Matèrne (jhm)  a écrit :
> 
> Doc's mentioning 'how to document' must be updated.
> I found http://ant.apache.org/ivy/write-doc.html Some more?

This is the only page which explain xooki I know.

Nicolas

> 
> Jan
> 
>> -Ursprüngliche Nachricht-
>> Von: Jaikiran Pai [mailto:jai.forums2...@gmail.com]
>> Gesendet: Montag, 19. Juni 2017 04:52
>> An: Ant Developers List
>> Betreff: Ivy - we have now moved to asciidoc for docs
>> 
>> The documentation for ant-ivy project has now been migrated to
>> asciidoc. The migration used a tool developed by Nicolas to migrate the
>> xooki backed HTML docs to asciidoc. This tool auto-generated the
>> asciidoc text and for most part no other changes were needed. However,
>> there are some fixes the generated asciidoc will need which I’m doing
>> and will continue to do in the coming days to fix any issues with the
>> generated doc. Once the fixes are done, soon, we’ll remove the xooki
>> backed documentation completely from our git repo. For now though, any
>> new documentation or changes should go into the asciidoc files.
>> 
>> -Jaikiran
>> -
>> To unsubscribe, e-mail: dev-unsubscr...@ant.apache.org For additional
>> commands, e-mail: dev-h...@ant.apache.org
> 
> 
> 
> -
> To unsubscribe, e-mail: dev-unsubscr...@ant.apache.org
> For additional commands, e-mail: dev-h...@ant.apache.org
> 


-
To unsubscribe, e-mail: dev-unsubscr...@ant.apache.org
For additional commands, e-mail: dev-h...@ant.apache.org

Re: Ivy - we have now moved to asciidoc for docs

[Nicolas Lalevée]

> Le 19 juin 2017 à 04:52, Jaikiran Pai  a écrit :
> 
> The documentation for ant-ivy project has now been migrated to asciidoc. The 
> migration used a tool developed by Nicolas to migrate the xooki backed HTML 
> docs to asciidoc. This tool auto-generated the asciidoc text and for most 
> part no other changes were needed. However, there are some fixes the 
> generated asciidoc will need which I’m doing and will continue to do in the 
> coming days to fix any issues with the generated doc. Once the fixes are 
> done, soon, we’ll remove the xooki backed documentation completely from our 
> git repo. For now though, any new documentation or changes should go into the 
> asciidoc files.

I did a general grep about finding non translated html markup, and I have 
cleaned the ones I have found.
I have pushed the result here: http://people.apache.org/~hibou/doc/ 


Probably we can start pushing it to the site, since there is section dedicated 
to the trunk version of the doc (which should be probably renamed master).
http://ant.apache.org/ivy/history/trunk/index.html 

It would be an opportunity to get an idea of what would it mean when a release 
will happen.

I have noticed one bug in the generation of the toc. There is notion of 
abstract node, which has a title but no link, it shouldn’t be clickable. But 
for instance the node at Reference/Introduction is clickable, and sends to the 
home. This should be fixed. I mentioning it if somebody wants to look at it, 
before me. 

And just an idea: since there are a lot of pages, maybe we could organize a 
review at many, without useless double checks. I see 4 big parts in the doc: 
the ant tasks, the pages related to the ivy file, the pages related to the 
ivysettings, and the other pages. If 4 volunteers can do a quick review of each 
page, I think we can be pretty confident that we didn’t leave any ugliness 
somewhere. The goal wouldn’t to do a fine grain review, but ensure that 
everything is readable. wdyt ?

Nicolas