[
https://issues.apache.org/jira/browse/TIKA-1269?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14072368#comment-14072368
]
Lewis John McGibbney commented on TIKA-1269:
--------------------------------------------
Hi [~gagravarr] yeah I have a couple of thoughts here
* use the maven-assembly-plugin to generate the following release artifacts,
server without packaged dependencies, server with packaged depdencies and
embedded server (similar to what we currently have) which is invoked via bash
script and which runs via org.mortbay.jetty:jetty-runner.
* also put work into the .war file which we can run as a web app within any
servlet container... as we also do with Any23.
For the artifacts which ship with the generated artifacts, we would simply
define the generated Miredot documentation as resources within the XML
descriptors for the plugin Maven configuration.
As for the WAR documentation, we would define them as WebResources which would
then be picked up by the maven-war-plugin when we generate the WAR artifact.
I therefore propose (if you guys are happy with using Miredot for the
documentation) that we commit the current patch on this issue, then address the
Javadoc as well as JAX-RS Annotations in a separate issue, before writing the
assembly descriptors and web application WAR file all in separate issues.
wdyt?
> Self-hosted documentation for the JAX-RS Server
> -----------------------------------------------
>
> Key: TIKA-1269
> URL: https://issues.apache.org/jira/browse/TIKA-1269
> Project: Tika
> Issue Type: Improvement
> Components: server
> Affects Versions: 1.5
> Reporter: Nick Burch
> Fix For: 1.7
>
> Attachments: TIKA-1269-miredot.patch, enable-enunciate.patch
>
>
> Currently, if you fire up the JAX-RS Tika Server, and go to the root of the
> server in a web browser, you get an empty page back. You have to know to head
> over to https://wiki.apache.org/tika/TikaJAXRS find out what the available
> URLs are
> We should self-host some simple documentation on the server at the root of
> it, so that people can discover what it offers. Ideally, this should be
> largely auto-generated based on the endpoints, so that we don't risk missing
> things when we add new features
> This will also allow us to potentially offer a sample running version of the
> server for people to discover Tika with
--
This message was sent by Atlassian JIRA
(v6.2#6252)
