[jbosstools-issues] [JBoss JIRA] (TOOLSDOC-492) Create new docs landing page on new tools.jboss.org site (moving to asciidoc for docs in process)

[Nick Boldt (JIRA)]

    [ https://issues.jboss.org/browse/TOOLSDOC-492?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12965274#comment-12965274 ] 

Nick Boldt edited comment on TOOLSDOC-492 at 5/3/14 9:53 AM:
-------------------------------------------------------------

After much ado, we can now generate from docbook all the following formats: pandoc extended markdown, asciidoc, pdf, epub, html5.

https://github.com/nickboldt/jbosstools-documentation/blob/TOOLSDOC-492/docs/User_Guide/JBoss_Tools_User_Guide/en-US/chap-OpenShift_Tools.adoc
https://github.com/nickboldt/jbosstools-documentation/blob/TOOLSDOC-492/docs/User_Guide/JBoss_Tools_User_Guide/en-US/chap-OpenShift_Tools.pdf?raw=true  -> screenshot: [^openshift-chapter-generated-pdf.png]
https://github.com/nickboldt/jbosstools-documentation/blob/TOOLSDOC-492/docs/User_Guide/JBoss_Tools_User_Guide/en-US/chap-OpenShift_Tools.epub?raw=true -> screenshot: [^openshift-chapter-generated-epub.png]
https://github.com/nickboldt/jbosstools-documentation/blob/TOOLSDOC-492/docs/User_Guide/JBoss_Tools_User_Guide/en-US/chap-OpenShift_Tools.html?raw=true

The script now allows for commandline flags which will optionally produce the 3 extra formats (html, pdf, and epub), and can swap docbook tags markdown/asciidoc don't understand for tags they do.

Remaining TODOs will be tracked in the script, as they'll be fixed there too.

{code:title=https://github.com/nickboldt/jbosstools-documentation/blob/TOOLSDOC-492/util/docbook2asciidoc.sh}
  # TODO: figure out what tags to use instead of <command> if we want *bold*, /italic/, or _underline_ instead of `code`
  # TODO: this should use <tags> not just tagNames so that no copy gets changed (eg., command or procedure or step)
  # TODO: fix remaining indented blocks; do we need to worry about indented CODE blocks, or is EVERYTHING just paragraphs?
  # TODO: add hard rules before each new top level "=" sections
{code}


was (Author: nickboldt):
After much ado, we can now generate from docbook all the following formats: pandoc extended markdown, asciidoc, pdf, epub, html5.

https://github.com/nickboldt/jbosstools-documentation/blob/TOOLSDOC-492/docs/User_Guide/JBoss_Tools_User_Guide/en-US/chap-OpenShift_Tools.adoc
https://github.com/nickboldt/jbosstools-documentation/blob/TOOLSDOC-492/docs/User_Guide/JBoss_Tools_User_Guide/en-US/chap-OpenShift_Tools.pdf?raw=true
https://github.com/nickboldt/jbosstools-documentation/blob/TOOLSDOC-492/docs/User_Guide/JBoss_Tools_User_Guide/en-US/chap-OpenShift_Tools.html?raw=true
https://github.com/nickboldt/jbosstools-documentation/blob/TOOLSDOC-492/docs/User_Guide/JBoss_Tools_User_Guide/en-US/chap-OpenShift_Tools.epub?raw=true

The script now allows for commandline flags which will optionally produce the 3 extra formats (html, pdf, and epub), and can swap docbook tags markdown/asciidoc don't understand for tags they do.

Remaining TODOs will be tracked in the script, as they'll be fixed there too.

{code:title=https://github.com/nickboldt/jbosstools-documentation/blob/TOOLSDOC-492/util/docbook2asciidoc.sh}
  # TODO: figure out what tags to use instead of <command> if we want *bold*, /italic/, or _underline_ instead of `code`
  # TODO: this should use <tags> not just tagNames so that no copy gets changed (eg., command or procedure or step)
  # TODO: fix remaining indented blocks; do we need to worry about indented CODE blocks, or is EVERYTHING just paragraphs?
  # TODO: add hard rules before each new top level "=" sections
{code}

> Create new docs landing page on new tools.jboss.org site (moving to asciidoc for docs in process)
> -------------------------------------------------------------------------------------------------
>
>                 Key: TOOLSDOC-492
>                 URL: https://issues.jboss.org/browse/TOOLSDOC-492
>             Project: Documentation for JBoss Tools and Developer Studio
>          Issue Type: Bug
>      Security Level: Public(Everyone can see) 
>          Components: User Guide
>    Affects Versions: 4.2.0.Beta1
>            Reporter: Nick Boldt
>            Assignee: Michelle Murray
>             Fix For: 4.2.0.Beta2
>
>         Attachments: openshift-chapter-generated-epub.png, openshift-chapter-generated-pdf.png
>
>
> With the release of the new tools.jboss.org site, it's time to migrate the docs to the same skin / format / markup. Docbook is dead, long live Asciidoc!
> What [~mmurray] and I are thinking is that we would have a new landing page similar to one of these:
> http://tools.jboss.org/features/ (with icons that link to projects' latest doc)
> or
> http://tools.jboss.org/documentation/whatsnew/ (with the latest doc linked)
> And then under that landing page we'd have doc for each of projects' contributions to the User Guide, by milestone or Final release.
> Questions:
> a. [~maxandersen] [~burrsutter] [~mmusaji] Do we still need to provide 3 formats of doc - HTML, HTML-single, and PDF? Or can we replace that with this new content, PLUS include inline help doc within Eclipse? (That's another issue - see [~dgolovin] 's https://github.com/dgolovin/jbosstools-eclipse-docs/blob/master/docs/scenarios.md for prototype)
> b. [~maxandersen] Should we include docs for "dead" projects like Freemarker, Portal, etc.? I'm guessing YES, even if the doc becomes out of date (ie., the doc for JBT 4.2 for Freemarker won't have changed much (or at all) since JBT 4.0/4.1).
> c. [~maxandersen] Should we convert old JBT 4.1.x (and/or 4.0.x, 3.3.x) doc to the new adoc format, or just start w/ the JBT 4.2.0.Beta1/2 doc? I'd be OK with 4.1 and maybe 4.0, but can we skip 3.3 since JBDS 5 is no longer fully supported?
> d. Will docbook2asciidoc [0] work for batch-converting docbook docs to adoc? @nick will try. If conversion works easily, then converting older User Guides is definitely more doable / less time consuming.
> [0] https://github.com/oreillymedia/docbook2asciidoc
> e. [~xcoulon] Is :page-component_version: still used, eg., in [1], or is the filename version itself used to categorize the content by milestone?
> [1] https://github.com/jbosstools/jbosstools-website/blob/master/documentation/whatsnew/openshift/openshift-news-2.6.0.Beta1.adoc
> f. If we decide to continue to include other formats (eg., html-single, pdf) should we link to those from these places [2], [3]?
> [2] http://tools.jboss.org/downloads/overview.html
> [3] http://tools.jboss.org/downloads/jbosstools/luna/4.2.0.Beta1.html



--
This message was sent by Atlassian JIRA
(v6.2.3#6260)