[Devtools] [atomic-devel] Proposal - Moving container development tools docs to the Asciidoc format

Brian (bex) Exelbierd bex at pobox.com
Mon Jun 6 08:36:22 UTC 2016


On 05/26/2016 03:26 PM, Stephen Milner wrote:
> On Mon, May 23, 2016 at 2:44 PM, Josh Berkus <jberkus at redhat.com> wrote:
>> I'm happy for this to be our default, but I'm concerned about making
>> existing projects port their docs.  For one thing, at least a couple of
>> projects make use of readthedocs.org, which requires a different format.
>
> Agreed. Commissiare makes use of reST for readthedocs and, AFAIK,
> there is no planned support at RTD for asciidoc or other formats. I've
> not personally tried pandoc to see how well it would convert between
> the two but that may be an option for those of us currently on RTD.

I don't think we need to do a conversion.  docs.pa.o is theoretically 
able to accept anything with a known conversion toolchain to html, which 
reST does.

The question I think we need to answer is do you want to publish the 
docs in two places or not.  If not, which source is considered 
authoritative and which should have a redirect?

regards,

bex




More information about the Devtools mailing list