[GitHub] ant-ivy pull request #47: Move to asciidoc for documentation

classic Classic list List threaded Threaded
2 messages Options
Reply | Threaded
Open this post in threaded view
|

[GitHub] ant-ivy pull request #47: Move to asciidoc for documentation

bodewig
GitHub user jaikiran opened a pull request:

    https://github.com/apache/ant-ivy/pull/47

    Move to asciidoc for documentation

    This PR contains multiple commits, which together are a first step towards moving the current `xooki` backed documentation to `asciidoc`. The commits are classified as follows:
   
     - The first set of commits are from Nicolas, to have an auto-conversion tool which converts the existing docs to `.adoc` files
     - The next commit https://github.com/jaikiran/ant-ivy/commit/22bdffb96dd29d98e2eb7b7f9f3a48a46ccc86ce is where I ran that tool to generate the .adoc files (this is a one time thing). After this is done, I then started fixing any issues that are present in the .adoc files.
     - This commit https://github.com/jaikiran/ant-ivy/commit/c73d10e072dfc53a428e1980259f25920d98345f fixes the heading levels in the .adoc files, which had incorrect heading levels
     - Some .adoc files had incorrect nested lists. This commit https://github.com/jaikiran/ant-ivy/commit/88d2e93800289d5542759a7ebf017d7c686b456f fixes that
     - While generating the final `html` content from the `.adoc` files, we run some tutorials which generate logs that we then include in the `html` files. This commit https://github.com/jaikiran/ant-ivy/commit/c50f4b4cb151a3999744d5dc1068250ca3a170b6 makes sure that we don't commit those logs to version control.
   
    This is by no means the final documentation fixes, but one step closer to making it easier to maintain asciidoc documentation. In the next few days, I will continue fixing issues (there are some I am aware of) in these asciidoc content in separate smaller and very focused PRs. I did not include them in this PR to avoid having to review an extremely large PR (this current one itself is big enough, but there isn't a way I can avoid this one).
   
    P.S: I haven't intentionally deleted the existing xooki backed documentation. I'll do that a few PRs down the line.

You can merge this pull request into a Git repository by running:

    $ git pull https://github.com/jaikiran/ant-ivy xooki2asciidoc

Alternatively you can review and apply these changes as the patch at:

    https://github.com/apache/ant-ivy/pull/47.patch

To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:

    This closes #47
   
----
commit 879ac405ee80f91b574517355f029a406d123302
Author: Nicolas Lalevée <[hidden email]>
Date:   2014-12-27T22:42:13Z

    Experimental xooki to asciidoc convertor

commit b3d2c0cd6512a9dc9c6d17e4065cba1521791f4d
Author: Jean-Louis Boudart <[hidden email]>
Date:   2014-12-30T16:37:07Z

    Make xooki2asciidoc work on java8+ based jvm.
   
    Nashorn is not a drop-in replacement JavaScript implementation for Rhino.
    see https://bugs.openjdk.java.net/browse/JDK-8025132 for further details

commit 64b328d822661bb3aa3d90356a9b5e3821b9ae1c
Author: Nicolas Lalevée <[hidden email]>
Date:   2015-02-15T15:20:14Z

    improve the xooki2asciidoc convertor

commit 610c3be2cd0105b6e838a69c682e65f594259a25
Author: Nicolas Lalevée <[hidden email]>
Date:   2015-02-15T22:35:52Z

    improve the xooki2asciidoc convertor

commit 3d72f1db6ab39787c6df7ab893828a95a9adef1e
Author: Nicolas Lalevée <[hidden email]>
Date:   2015-02-16T11:16:20Z

    setup the build to use asciidoc files as the source of truth

commit 1760b262c2d99d7803184e471116478ef18ff4c8
Author: Nicolas Lalevée <[hidden email]>
Date:   2017-05-25T12:55:24Z

    - update asciidoctor
    - improve transforming xooki source into asciidoc source

commit 5d6131a3012135602ecbd9b7894a622ec5f75782
Author: Nicolas Lalevée <[hidden email]>
Date:   2017-05-25T13:04:39Z

    Merge branch 'master' into xooki2asciidoc

commit 32296ea3915941404eb602a0c4852bb8641149bf
Author: Jaikiran Pai <[hidden email]>
Date:   2017-06-15T07:40:12Z

    Merge latest master changes

commit 22bdffb96dd29d98e2eb7b7f9f3a48a46ccc86ce
Author: Jaikiran Pai <[hidden email]>
Date:   2017-06-15T13:07:16Z

    Initial auto-converted .adoc files from xooki2asciidoc convertor

commit c73d10e072dfc53a428e1980259f25920d98345f
Author: Jaikiran Pai <[hidden email]>
Date:   2017-06-15T13:25:33Z

    Fix heading levels to take care of the asciidoc warnings

commit 88d2e93800289d5542759a7ebf017d7c686b456f
Author: Jaikiran Pai <[hidden email]>
Date:   2017-06-15T14:27:59Z

    Fix incorrect "lists" in documentation

commit c50f4b4cb151a3999744d5dc1068250ca3a170b6
Author: Jaikiran Pai <[hidden email]>
Date:   2017-06-15T14:29:09Z

    Don't commit tutorial logs generated during build

----


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at [hidden email] or file a JIRA ticket
with INFRA.
---

---------------------------------------------------------------------
To unsubscribe, e-mail: [hidden email]
For additional commands, e-mail: [hidden email]

Reply | Threaded
Open this post in threaded view
|

[GitHub] ant-ivy pull request #47: Move to asciidoc for documentation

bodewig
Github user asfgit closed the pull request at:

    https://github.com/apache/ant-ivy/pull/47


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at [hidden email] or file a JIRA ticket
with INFRA.
---

---------------------------------------------------------------------
To unsubscribe, e-mail: [hidden email]
For additional commands, e-mail: [hidden email]