Re: reStructuredText vs. AsciiDoc

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



On Tue, Sep 20, 2016 at 7:25 AM, John Spray <jspray@xxxxxxxxxx> wrote:
> Hi all,
>
> Currently the Ceph upstream documentation is mostly written in
> restructuredtext, and built into HTML with Sphinx.
>
> We at Red Hat have some writer colleagues who are more comfortable
> with asciidoc, and it has been suggested that we could get more new
> content upstream (i.e. on github for everyone) if we were using
> asciidoc.

The barrier to contribute from asciidoc to rst is not huge, it is
mainly inconvenient. I think there is much more to gain
from current contributors to raise the bar to improve the current state of docs.

>
> So does anyone have any strong attachment to the restructuredtext
> format currently in use?

I really like RestructuredText, but an important question here is:
*if* we decided to move, are we aware of the burden that means
to generate: html, man pages, and the porting of the extensions
(doxygen, ditaa, and maybe something else I might be missing)

>
> (Opinions especially valued from people/groups who are active
> contributors to the docs)
>
> John
> --
> To unsubscribe from this list: send the line "unsubscribe ceph-devel" in
> the body of a message to majordomo@xxxxxxxxxxxxxxx
> More majordomo info at  http://vger.kernel.org/majordomo-info.html
--
To unsubscribe from this list: send the line "unsubscribe ceph-devel" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html



[Index of Archives]     [CEPH Users]     [Ceph Large]     [Information on CEPH]     [Linux BTRFS]     [Linux USB Devel]     [Video for Linux]     [Linux Audio Users]     [Yosemite News]     [Linux Kernel]     [Linux SCSI]
  Powered by Linux