accumulo-notifications mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Christopher Tubbs (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (ACCUMULO-4545) Update User Manual to use Slate
Date Tue, 03 Jan 2017 21:59:58 GMT

    [ https://issues.apache.org/jira/browse/ACCUMULO-4545?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15796312#comment-15796312
] 

Christopher Tubbs commented on ACCUMULO-4545:
---------------------------------------------

Slate is really great for documenting commands and APIs, in particular. It's a bit confusing
for long amounts of text.

However, the biggest problem I can see with using it, is that it's not easy to generate using
our existing build tooling, and the output is not the single-file-manuscript that we currently
have today, which is really convenient for re-publication (like a PDF).


> Update User Manual to use Slate
> -------------------------------
>
>                 Key: ACCUMULO-4545
>                 URL: https://issues.apache.org/jira/browse/ACCUMULO-4545
>             Project: Accumulo
>          Issue Type: Improvement
>          Components: docs
>            Reporter: Luis Tavarez
>            Priority: Minor
>              Labels: documentation
>
> I was looking at the Timely documentation (https://nationalsecurityagency.github.io/timely/docs/)
and saw that they use Slate for it, which looks really nice (specially for big documents such
as the Accumulo manual). I was wondering if it would be possible to update the Accumulo User
Manual to use Slate instead of asciidocs. 



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)

Mime
View raw message