[
https://issues.apache.org/jira/browse/IMPALA-3849?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
John Russell resolved IMPALA-3849.
----------------------------------
Resolution: Later
This is a longer-term item that is best scoped and addressed if and when the
need becomes more acute (lots of specs for developers to write, developers
eager to contribute on the doc side but blocked by having to use XML). Gently
putting aside for now so it doesn't show up in my queue.
> Investigate use of Markdown -> DITA plugin to allow contributions and
> maintenance to be done via simpler authoring process
> --------------------------------------------------------------------------------------------------------------------------
>
> Key: IMPALA-3849
> URL: https://issues.apache.org/jira/browse/IMPALA-3849
> Project: IMPALA
> Issue Type: Task
> Components: Docs
> Affects Versions: Impala 2.5.0
> Reporter: John Russell
> Assignee: John Russell
> Priority: Trivial
> Labels: asf
>
> This plugin: https://github.com/jelovirt/dita-ot-markdown
> allows content to be written in Markdown, and then converted to DITA
> on-the-fly and processed by the DITA XML transforms. This JIRA is to do some
> evaluation whether it would make sense to integrate it into the Apache Impala
> publication process.
> Ways that we could potentially use it:
> * Have spec material initially written by developers in Markdown. Then that
> source could be easily ingested into the documentation for reuse. (Once the
> content is solidified, we could capture the converted XML output and use that
> for future edits, if desired. The Markdown->DITA plugin appeared to be
> somewhat immature in initial testing, so it might not support all the kinds
> of tag structures that we use in other places in the docs.)
> * Have sections with high volume of external or developer contribution done
> in Markdown, for simplicity and familiarity on the editing side.
> * Have some kinds of plain vanilla auto-generated content produced as
> Markdown. For example, if someday we made autogenerated reference topics for
> all the command-line flags, profile counters, or similar things.
--
This message was sent by Atlassian JIRA
(v6.4.14#64029)
