[JBoss JIRA] (TOOLSDOC-492) Create new docs landing page on new tools.jboss.org site (moving to asciidoc for docs in process)
by Nick Boldt (JIRA)
[ https://issues.jboss.org/browse/TOOLSDOC-492?page=com.atlassian.jira.plug... ]
Nick Boldt updated TOOLSDOC-492:
--------------------------------
Attachment: converted-adoc-github-css.png
converted-adoc-asciidoc-css-not-github-css.png
converted-adoc-github-css-actual.png
Bullets are back, and unordered lists are now once again unordered, including the blocks which were shown as preformatted/code now appearing as regular paragraph text.
Note that CSS controls how the NOTE and IMPORTANT blocks appear, and how the bullets are rendered.
Below are screenshots showing two ways to use the Asciidoctor.js Live Preview plugin in Chrome, followed by the CSS that github actually applies (bullets DO appear on github, even if the Asciidoctor.js preview doesn't show them; however, github does NOT render the NOTE and IMPORTANT icons).
*Asciidoctor.js default skin:*
!converted-adoc-asciidoc-css-not-github-css.png!
*Asciidoctor.js github skin:*
!converted-adoc-github-css.png!
*Actual github skin:*
!converted-adoc-github-css-actual.png!
> 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: converted-adoc-asciidoc-css-not-github-css.png, converted-adoc-github-css-actual.png, converted-adoc-github-css.png, 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/scen... 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/documentatio...
> 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)
11 years, 11 months
[JBoss JIRA] (TOOLSDOC-492) Create new docs landing page on new tools.jboss.org site (moving to asciidoc for docs in process)
by Michelle Murray (JIRA)
[ https://issues.jboss.org/browse/TOOLSDOC-492?page=com.atlassian.jira.plug... ]
Michelle Murray commented on TOOLSDOC-492:
------------------------------------------
Looks really good!
Some pointers:
* Procedures now have numbered steps - great
* Substeps (and presumably alternative steps) have lost their numbering (e.g., Connect to OpenShift step 7) - can we do anything about this?
* Bullet lists are now also numbered - need to revert this back to just being bullets (e.g., lists in About OpenShift, About OpenShift Tools, Features Overview)
* Note and Important admonitions now have a table-ish format - these looked pretty cool before with the grey line on the LHS, can we revert to that?
* Under 'View output from the OpenShift server' the text should be one para but has been split into a para and the unformatted text in a grey box (similarly under 'Forward remote ports') - need to fix this
> 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/scen... 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/documentatio...
> 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)
11 years, 11 months
[JBoss JIRA] (JBIDE-17224) Typo in BrowserSim WebKitGTK error message: is > has
by Michelle Murray (JIRA)
Michelle Murray created JBIDE-17224:
---------------------------------------
Summary: Typo in BrowserSim WebKitGTK error message: is > has
Key: JBIDE-17224
URL: https://issues.jboss.org/browse/JBIDE-17224
Project: Tools (JBoss Tools)
Issue Type: Bug
Components: browsersim
Affects Versions: 4.2.0.Beta1
Reporter: Michelle Murray
There is a typo in the BrowserSim WebKitGTK error message.
Error message: "BrowserSim is failed to start with the following error:"
Typo: is > has
!BrowserSim_ErrorGTK.png!
--
This message was sent by Atlassian JIRA
(v6.2.3#6260)
11 years, 11 months
[JBoss JIRA] (JBIDE-17125) Website: Text in banner/header should not contain "A"
by Nick Boldt (JIRA)
[ https://issues.jboss.org/browse/JBIDE-17125?page=com.atlassian.jira.plugi... ]
Nick Boldt edited comment on JBIDE-17125 at 5/4/14 9:32 PM:
------------------------------------------------------------
PR to fix classname, label, and comments. Worked locally but the JBoss Tools banner wouldn't display (could be a XSS thing on my machine preventing the image from loading from jboss.org within localhost:4242 site ?)
https://github.com/jbosstools/jbosstools-website/pull/125
was (Author: nickboldt):
PR to fix classname, label, and comments. Worked locally but the JBoss Tools banner wouldn't display (could be a XSS thing on my machine preventing the image from loading from jboss.org within localhost:4242 site ?)
> Website: Text in banner/header should not contain "A"
> -----------------------------------------------------
>
> Key: JBIDE-17125
> URL: https://issues.jboss.org/browse/JBIDE-17125
> Project: Tools (JBoss Tools)
> Issue Type: Enhancement
> Components: website
> Affects Versions: 4.2.0.Beta1
> Reporter: Marián Labuda
> Assignee: Nick Boldt
> Priority: Minor
> Fix For: 4.2.0.Beta2
>
> Attachments: header.png
>
>
> Banner / header or whatever it is called contain text "A JBoss Project". I think that "A" should not be here - it should be "JBoss Project". !header.png!
--
This message was sent by Atlassian JIRA
(v6.2.3#6260)
11 years, 11 months
[JBoss JIRA] (JBDS-3023) Universal installer step4 Java statement needs updating
by Michelle Murray (JIRA)
Michelle Murray created JBDS-3023:
-------------------------------------
Summary: Universal installer step4 Java statement needs updating
Key: JBDS-3023
URL: https://issues.jboss.org/browse/JBDS-3023
Project: Developer Studio (JBoss Developer Studio)
Issue Type: Bug
Security Level: Public (Everyone can see)
Components: installer
Affects Versions: 8.0.0.Beta1
Reporter: Michelle Murray
Universal installer, step 4 states:
"JBoss Developer Studio works with Java 6 and 7 and has been tested with OpenJDK, Oracle and Apple JDK."
According to the approved QE test plan (mojo DOC-932620):
* Only Java 7 and Java 8 are supported for running the IDE (Java 6 support for app development only)
* Apple JDK (which is Java 6) is not supported for running the IDE; it's supported for app development only
For clarity, suggest changing text to:
"JBoss Developer Studio can be run with Java 7 and 8 and has been tested with OpenJDK and Oracle JDK."
--
This message was sent by Atlassian JIRA
(v6.2.3#6260)
11 years, 11 months