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

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

An Issue (and fixing PR) has been opened to convert the vagrant-service-manager docs per the below


I'd encourage everyone to take a look so we can close this via lazy consensus and then we (docs) can begin looking at adb and adb-utils.



On 05/23/2016 03:33 PM, Preeti Chandrashekar wrote:
Hi All,

In line with our ongoing efforts at streamlining the docs process, and
in order to ensure better upstream-downstream coordination, we are
proposing to move to the Asciidoc format for docs related to container
development tools in Project Atomic.

Adoption of Asciidoc would:
- allow us to leverage existing code for publishing to
docs.projecatomic.io <http://docs.projecatomic.io/>.
- allow for easier contribution by downstream communities that have
standardized on Asciidoc.

AsciiDoc belongs to the family of lightweight markup languages, the most
renowned of which is Markdown [1]. It is very similar to markdown in
terms of formatting and is not that steep a curve in terms of learning [2].

Please let us know what you think about this so that the docs team can
freeze on the process.

[1] [http://asciidoctor.org/docs/what-is-asciidoc/]
[2] [http://asciidoctor.org/docs/asciidoc-syntax-quick-reference/]

Thank you,

Devtools mailing list
Devtools redhat com

Brian (bex) Exelbierd | bex pobox com
+420-606-055-877 | @bexelbie

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