[
https://issues.apache.org/jira/browse/VXQUERY-143?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14525984#comment-14525984
]
Till Westmann commented on VXQUERY-143:
---------------------------------------
The website is built using the maven site plugin [1]. The sources for the site
are in vxquery/src/site. In there you will find a directory called "apt" that
contains the sources in the APT format [2]. However, you don't have to use the
APT format, you could also use Markdown [3]. To do that you would create a
directory "markdown" inside of the site directory and put your Markdown sources
in that directory. The maven site plugin should translate those as well.
The structure of the site is described in site.xml in the site directory.
To build/test the site, you should
1) create a directory that is called "site" next to the vxquery root directory
(the site is deployed to "../site" from the vxquery root directory) and
2) run "mvn site site:deploy" to build the site and deploy it to the directory
that you've just created.
[1] https://maven.apache.org/plugins/maven-site-plugin/
[2] https://maven.apache.org/doxia/references/apt-format.html
[3]
https://maven.apache.org/doxia/doxia/doxia-modules/doxia-module-markdown/index.html
> We need cluster documentation
> -----------------------------
>
> Key: VXQUERY-143
> URL: https://issues.apache.org/jira/browse/VXQUERY-143
> Project: VXQuery
> Issue Type: Documentation
> Reporter: Steven Jacobs
> Priority: Minor
>
> Currently, we have no documentation for how to start/stop/maintain the
> cluster in VXQuery. It would also be nice to have documentation showing what
> the cluster actually looks like.
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
