You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@zookeeper.apache.org by tamaashu <gi...@git.apache.org> on 2018/09/26 06:38:41 UTC
[GitHub] zookeeper pull request #643: ZOOKEEPER-3153: Create MarkDown files and build...
GitHub user tamaashu opened a pull request:
https://github.com/apache/zookeeper/pull/643
ZOOKEEPER-3153: Create MarkDown files and build process for them
In this sub-task we have transformed the Forest XML documents into MarkDown (.md) files and provided a (maven based) solution to create HTML documentation from them.
PDF support is dropped since it is not really used and makes everything overcomplicated.
The generated HTML content looks similar to the one generated from Forest XMLs, but not identical with them.
Change-Id: Id35984eca5d37b9e3074eab939be5c9b4cc80257
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/tamaashu/zookeeper ZOOKEEPER-3153
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/zookeeper/pull/643.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 #643
----
commit 72d30441c4565434fc7870fb2e6fb2ee031184cb
Author: Tamas Penzes <ta...@...>
Date: 2018-09-26T06:34:51Z
ZOOKEEPER-3153: Create MarkDown files and build process for them
In this sub-task we have transformed the Forest XML documents into MarkDown (.md) files and provided a (maven based) solution to create HTML documentation from them.
PDF support is dropped since it is not really used and makes everything overcomplicated.
The generated HTML content looks similar to the one generated from Forest XMLs, but not identical with them.
Change-Id: Id35984eca5d37b9e3074eab939be5c9b4cc80257
----
---
[GitHub] zookeeper issue #643: ZOOKEEPER-3153: Create MarkDown files and build proces...
Posted by tamaashu <gi...@git.apache.org>.
Github user tamaashu commented on the issue:
https://github.com/apache/zookeeper/pull/643
retest this please
---
[GitHub] zookeeper issue #643: ZOOKEEPER-3153: Create MarkDown files and build proces...
Posted by tamaashu <gi...@git.apache.org>.
Github user tamaashu commented on the issue:
https://github.com/apache/zookeeper/pull/643
@hanm
If you do `mvn clean install` it creates the HTML content in zookeeper-docs/target/html/
I will start a discuss on dev list about dropping PDF support.
---
[GitHub] zookeeper issue #643: ZOOKEEPER-3153: Create MarkDown files and build proces...
Posted by asfgit <gi...@git.apache.org>.
Github user asfgit commented on the issue:
https://github.com/apache/zookeeper/pull/643
Refer to this link for build results (access rights to CI server needed):
https://builds.apache.org/job/PreCommit-ZOOKEEPER-github-pr-build/2362/
---
[GitHub] zookeeper issue #643: ZOOKEEPER-3153: Create MarkDown files and build proces...
Posted by tamaashu <gi...@git.apache.org>.
Github user tamaashu commented on the issue:
https://github.com/apache/zookeeper/pull/643
retest this please
---
[GitHub] zookeeper issue #643: ZOOKEEPER-3153: Create MarkDown files and build proces...
Posted by asfgit <gi...@git.apache.org>.
Github user asfgit commented on the issue:
https://github.com/apache/zookeeper/pull/643
Refer to this link for build results (access rights to CI server needed):
https://builds.apache.org/job/PreCommit-ZOOKEEPER-github-pr-build/2333/
---
[GitHub] zookeeper issue #643: ZOOKEEPER-3153: Create MarkDown files and build proces...
Posted by tamaashu <gi...@git.apache.org>.
Github user tamaashu commented on the issue:
https://github.com/apache/zookeeper/pull/643
retest this please
---
[GitHub] zookeeper issue #643: ZOOKEEPER-3153: Create MarkDown files and build proces...
Posted by tamaashu <gi...@git.apache.org>.
Github user tamaashu commented on the issue:
https://github.com/apache/zookeeper/pull/643
Hi @nkalmar,
It is part of the next sub-task, please see my comment to @anmolnar.
---
[GitHub] zookeeper issue #643: ZOOKEEPER-3153: Create MarkDown files and build proces...
Posted by anmolnar <gi...@git.apache.org>.
Github user anmolnar commented on the issue:
https://github.com/apache/zookeeper/pull/643
Thanks @tamaashu , this is great.
To summarize what's included and what's not:
- root level pom.xml added - this is more-or-less part of the Maven migration, currently needed for `zookeeper-docs` maven sub-project
- xml docs are still present and not being removed in this patch - is that intentional?
- root level `docs` directory is still present - intentional?
---
[GitHub] zookeeper pull request #643: ZOOKEEPER-3153: Create MarkDown files and build...
Posted by asfgit <gi...@git.apache.org>.
Github user asfgit closed the pull request at:
https://github.com/apache/zookeeper/pull/643
---
[GitHub] zookeeper issue #643: ZOOKEEPER-3153: Create MarkDown files and build proces...
Posted by asfgit <gi...@git.apache.org>.
Github user asfgit commented on the issue:
https://github.com/apache/zookeeper/pull/643
Refer to this link for build results (access rights to CI server needed):
https://builds.apache.org/job/PreCommit-ZOOKEEPER-github-pr-build/2349/
---
[GitHub] zookeeper issue #643: ZOOKEEPER-3153: Create MarkDown files and build proces...
Posted by asfgit <gi...@git.apache.org>.
Github user asfgit commented on the issue:
https://github.com/apache/zookeeper/pull/643
Refer to this link for build results (access rights to CI server needed):
https://builds.apache.org/job/PreCommit-ZOOKEEPER-github-pr-build/2327/
---
[GitHub] zookeeper issue #643: ZOOKEEPER-3153: Create MarkDown files and build proces...
Posted by asfgit <gi...@git.apache.org>.
Github user asfgit commented on the issue:
https://github.com/apache/zookeeper/pull/643
Refer to this link for build results (access rights to CI server needed):
https://builds.apache.org/job/PreCommit-ZOOKEEPER-github-pr-build/2264/
---
[GitHub] zookeeper issue #643: ZOOKEEPER-3153: Create MarkDown files and build proces...
Posted by hanm <gi...@git.apache.org>.
Github user hanm commented on the issue:
https://github.com/apache/zookeeper/pull/643
hi @tamaashu - how to generate html documents based on mark down files?
>> PDF support is dropped since it is not really used and makes everything overcomplicated.
Seems good to me, but probably good to start a discuss dev mailing list just to make sure - since this is about dropping something we support?
---
[GitHub] zookeeper issue #643: ZOOKEEPER-3153: Create MarkDown files and build proces...
Posted by asfgit <gi...@git.apache.org>.
Github user asfgit commented on the issue:
https://github.com/apache/zookeeper/pull/643
Refer to this link for build results (access rights to CI server needed):
https://builds.apache.org/job/PreCommit-ZOOKEEPER-github-pr-build/2346/
---
[GitHub] zookeeper issue #643: ZOOKEEPER-3153: Create MarkDown files and build proces...
Posted by asfgit <gi...@git.apache.org>.
Github user asfgit commented on the issue:
https://github.com/apache/zookeeper/pull/643
Refer to this link for build results (access rights to CI server needed):
https://builds.apache.org/job/PreCommit-ZOOKEEPER-github-pr-build/2342/
---
[GitHub] zookeeper issue #643: ZOOKEEPER-3153: Create MarkDown files and build proces...
Posted by tamaashu <gi...@git.apache.org>.
Github user tamaashu commented on the issue:
https://github.com/apache/zookeeper/pull/643
retest this please
---
[GitHub] zookeeper issue #643: ZOOKEEPER-3153: Create MarkDown files and build proces...
Posted by tamaashu <gi...@git.apache.org>.
Github user tamaashu commented on the issue:
https://github.com/apache/zookeeper/pull/643
retest this please
---
[GitHub] zookeeper issue #643: ZOOKEEPER-3153: Create MarkDown files and build proces...
Posted by anmolnar <gi...@git.apache.org>.
Github user anmolnar commented on the issue:
https://github.com/apache/zookeeper/pull/643
Committed to master. Thanks @tamaashu !
---
[GitHub] zookeeper issue #643: ZOOKEEPER-3153: Create MarkDown files and build proces...
Posted by asfgit <gi...@git.apache.org>.
Github user asfgit commented on the issue:
https://github.com/apache/zookeeper/pull/643
Refer to this link for build results (access rights to CI server needed):
https://builds.apache.org/job/PreCommit-ZOOKEEPER-github-pr-build/2361/
---
[GitHub] zookeeper issue #643: ZOOKEEPER-3153: Create MarkDown files and build proces...
Posted by asfgit <gi...@git.apache.org>.
Github user asfgit commented on the issue:
https://github.com/apache/zookeeper/pull/643
Refer to this link for build results (access rights to CI server needed):
https://builds.apache.org/job/PreCommit-ZOOKEEPER-github-pr-build/2363/
---
[GitHub] zookeeper issue #643: ZOOKEEPER-3153: Create MarkDown files and build proces...
Posted by anmolnar <gi...@git.apache.org>.
Github user anmolnar commented on the issue:
https://github.com/apache/zookeeper/pull/643
@hanm @tamaashu I agree with discussing PDF generation with the community, but I wouldn't block this patch with that. Given that there's very little chance of somebody take advantage of PDF documentation *and* the fact that it needs significant effort to implement (somebody has to find a solution), I suggest committing this patch and take the discussion "offline".
---
[GitHub] zookeeper issue #643: ZOOKEEPER-3153: Create MarkDown files and build proces...
Posted by tamaashu <gi...@git.apache.org>.
Github user tamaashu commented on the issue:
https://github.com/apache/zookeeper/pull/643
Hi @anmolnar,
Yes it is intentional.
The original ticket was "ZOOKEEPER-925 Consider maven site generation to replace our forrest site and documentation generation" where I have created three sub-tasks:
* ZOOKEEPER-3153 Create MarkDown files and build process for them
* ZOOKEEPER-3154 Update release process to use the MarkDown solution
* ZOOKEEPER-3155 Remove Forrest XMLs and their build process from the project
This PR mainly covers the first one, just creating the markdown based documentation with the opportunity of generating HTML out of it. Adding the pom.xml files only happened to be able to build HTML within this step. (It is needed to be able to compare the result with the Forrest based generated files as part of the validation.)
In the next step I want to integrate this solution into the current ANT based process and add the needed documentation related files to the tarball we deliver. In this step I also want to modify the documentation about how to prepare the deliverable in the future.
As last I will clean up the old solution, like source files to Forrest based documentation, the docs directory and so on.
Since the parent ticket also contains migration of the website, I will have to add more sub-tasks in the future, when I finished these three.
---
[GitHub] zookeeper issue #643: ZOOKEEPER-3153: Create MarkDown files and build proces...
Posted by tamaashu <gi...@git.apache.org>.
Github user tamaashu commented on the issue:
https://github.com/apache/zookeeper/pull/643
retest this please
---