GitHub user spmallette opened a pull request:
https://github.com/apache/incubator-tinkerpop/pull/151
TINKERPOP3-928 Use directories to separate different books
https://issues.apache.org/jira/browse/TINKERPOP3-928
Note the new directory structure for `/docs`:
https://github.com/apache/incubator-tinkerpop/tree/TINKERPOP3-928/docs/src
Both `bin/process-docs.sh` and `bin/publish-docs.sh` have been tested.
Here's the published URLs for each of our books:
http://tinkerpop.incubator.apache.org/docs/3.1.1-SNAPSHOT/dev/developer/
http://tinkerpop.incubator.apache.org/docs/3.1.1-SNAPSHOT/reference/
http://tinkerpop.incubator.apache.org/docs/3.1.1-SNAPSHOT/tutorials/getting-started/
http://tinkerpop.incubator.apache.org/docs/3.1.1-SNAPSHOT/upgrade/
@dkuppitz and I also wrote up some docs on how to add new "books":
http://tinkerpop.incubator.apache.org/docs/3.1.1-SNAPSHOT/dev/developer/#documentation
My vote is +1
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/apache/incubator-tinkerpop TINKERPOP3-928
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/incubator-tinkerpop/pull/151.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 #151
----
commit 79b055678012c5b8ec41d75fc50b0866542ea303
Author: Stephen Mallette <[email protected]>
Date: 2015-11-20T10:54:32Z
Added comments to pom around asciidoc generation.
commit bc46d64982ba6e517b47baccf88a410f4d407dcc
Author: Stephen Mallette <[email protected]>
Date: 2015-11-20T11:53:39Z
Made subdirectories for various "books" in the docs.
At this point you can generate docs with --dryRun, but the pre/post
processors don't know what to do as the paths don't all point at the root of
doc generation anymore. That's the next step.
commit 28e0b280b598264483207693162dc42b23cf8b04
Author: Daniel Kuppitz <[email protected]>
Date: 2015-11-20T18:31:43Z
adjustments in the AsciiDoc preprocessor in order to make it work using the
new directory structure
commit 7d20789b87a6d0c635c82c7981c58f39bf75c29a
Author: Stephen Mallette <[email protected]>
Date: 2015-11-20T18:44:40Z
Fixed up headings that were out of sync
This cleans up the warnings asciidoctor was throwing during doc generation.
commit 3b7d7c920ddda5253ee49572e23dab980f2e1a71
Author: Stephen Mallette <[email protected]>
Date: 2015-11-20T19:07:05Z
Expanded the section on "documentation" in developer docs.
commit cc0c2baff2bef1518f5ffb3e69a2d30304bd8be2
Author: Daniel Kuppitz <[email protected]>
Date: 2015-11-20T21:11:18Z
removed the maven replacer plugin; version numbers are now being replaced
by the AsciiDocs post-processor
commit ead508d15539f17140efbca1a823eaa1dd5e94e6
Author: Daniel Kuppitz <[email protected]>
Date: 2015-11-20T21:12:55Z
minor fix in the AsciiDocs post-processor
----
---
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 [email protected] or file a JIRA ticket
with INFRA.
---
