[
https://issues.apache.org/jira/browse/DAFFODIL-2004?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16951357#comment-16951357
]
Mike Beckerle commented on DAFFODIL-2004:
-----------------------------------------
Our javadoc and scaladoc are HTML generated by tools.
To the site content, they're just verbatim copied into the deployed site.
Rather than mess with markdown, I think the tutorials should also just be
copied verbatim along with the stylesheet, css, and logos, etc. into a
deployment area in the site.
It's important that they are deployed this way, not as some file that has been
converted. Show Source in a browser should show the user the TDML file, not
something created from it.
Markdown is quite questionable to me. I like writing it. I don't like the fact
that there are so many flavors of it. E.g., jekyll's markdown, github's
markdown, and Atlassian confluence markdown are all slightly different. Of the
various kinds and toolchains, asciidoc seems to have advantages.
> daffodil site should have tutorials area
> ----------------------------------------
>
> Key: DAFFODIL-2004
> URL: https://issues.apache.org/jira/browse/DAFFODIL-2004
> Project: Daffodil
> Issue Type: Improvement
> Components: Documentation
> Reporter: Mike Beckerle
> Priority: Minor
>
> We host the DFDL spec (HTML version) on the daffodil site.
> Our tiny (but hopefully growing) set of TDML-based tutorial pages, and
> associated stylesheet to make them presentable, should be hosted on the
> daffodil-site also.
> I think this is a matter of just copying some files from the
> daffodil/tutorials module over into the site. These TDML files are run as
> part of regression however, so they really do need to live someplace where
> they can be run as tests as well as being presented on the site.
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
