[jira] [Updated] (TIKA-1269) Self-hosted documentation for the JAX-RS Server

["Lewis John McGibbney (JIRA)" <ji...@apache.org>]

     [ https://issues.apache.org/jira/browse/TIKA-1269?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Lewis John McGibbney updated TIKA-1269:
---------------------------------------

    Attachment: TIKA-1269-miredot.patch

Patch for enabling recent free license from Miredot.
The documentation looks great with a fully navigable tree for clean and efficient navigation of tika-server documentation.

I propose to commit this patch, hook it up to the Jenkins build and then open a subsequent issue to fully document all methods in tika-server with appropriate Javadoc. The license key is documented within the patch and is valid for around 2 years... around then we can apply for a new Key.

> 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)