Skip to main content
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index] [List Home]
Re: [che-dev] PR: Convert Che docs to Asciidoc
That is awesome ! 

Along with the nice capabilities that you highlight in your PR, this is also going to make it easier for ISV to be able to re-package and re-brand the documentation for their own product more easily. 

I know you put a lot of efforts into this Robert, so big kudos ! That is much appreciated and will benefit to the whole Che community. 

Thanks a lot for this work.

Stevan

On Tue, Aug 14, 2018 at 4:00 PM, Robert Kratky <rkratky@xxxxxxxxxx> wrote:
Hi all,

I have just submitted a PR to the Che docs repo [1] that converts the entire Che docs set from Markdown to Asciidoc(tor). I have provided a detailed explanation and reasoning for the move in the corresponding issue [2].

To quote from the issue: "AsciiDoc, while rather similar to Markdown in the simplicity of its syntax, offers, among other things:

* better formatting capabilities
* semantic tagging (useful for CI testing)
* native xrefs (links to other parts of the docs)
* macros and variables
* combining docs through native inclusions"

The PR outlines the proposed changes.

The change from one mark-up language to another should be totally transparent and barely noticeable for users. The converted site still uses Jekyll to generate the HTML, and the look & feel has not changed. All navigation and other site elements are unchanged.

Please, review and comment. Due to the scope of the PR, it would be great if it could be merged quickly (provided there are no objections), so that regular work on the docs can resume without necessitating a rerun of the conversion scripts.

Thanks for considering.

[1] https://github.com/eclipse/che-docs/pull/456
[2] https://github.com/eclipse/che-docs/issues/425

Regards,

--
Robert Krátký
P. Technical Writer, CCS
Red Hat Czech
_______________________________________________
che-dev mailing list
che-dev@xxxxxxxxxxx
To change your delivery options, retrieve your password, or unsubscribe from this list, visit
https://dev.eclipse.org/mailman/listinfo/che-dev



--

Stévan LeMeur // Product Manager // Developer Tools // +336-87-11-27-55 

Back to the top