[jira] [Commented] (DISPATCH-399) Convert documentation to asciidoc format

2016-06-30 Thread ASF subversion and git services (JIRA)

[ 
https://issues.apache.org/jira/browse/DISPATCH-399?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=15357830#comment-15357830
 ] 

ASF subversion and git services commented on DISPATCH-399:
--

Commit 27629e177e52fb2eec0b37e22b30b9e8b8ae0378 in qpid-dispatch's branch 
refs/heads/master from [~aconway]
[ https://git-wip-us.apache.org/repos/asf?p=qpid-dispatch.git;h=27629e1 ]

DISPATCH-399: Generate body-only HTML documentation for Qpid site.

Also added cmake variable to enable verbose output from doc tools for debugging.


> Convert documentation to asciidoc format
> 
>
> Key: DISPATCH-399
> URL: https://issues.apache.org/jira/browse/DISPATCH-399
> Project: Qpid Dispatch
>  Issue Type: Improvement
>  Components: Documentation
>Affects Versions: 0.6.0
>Reporter: Alan Conway
>Assignee: Alan Conway
>Priority: Minor
> Fix For: 0.7.0
>
>
> asciidoc format is becoming more popular for documentation and has several 
> advantages over RST + sphinx.
> - Mature, widely-used DocBook model without painful XML syntax
> - Multi-file documents and entity substitution are standard in asciidoc
>   (Sphinx has non-standard extensions, but not defined by RST)
> - simpler, more flexible tools, fewer generation steps.



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)

-
To unsubscribe, e-mail: dev-unsubscr...@qpid.apache.org
For additional commands, e-mail: dev-h...@qpid.apache.org



[jira] [Commented] (DISPATCH-399) Convert documentation to asciidoc format

2016-06-30 Thread ASF subversion and git services (JIRA)

[ 
https://issues.apache.org/jira/browse/DISPATCH-399?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=15357645#comment-15357645
 ] 

ASF subversion and git services commented on DISPATCH-399:
--

Commit da6688a53475f80e7ff81adc65484f587efef876 in qpid-dispatch's branch 
refs/heads/master from [~aconway]
[ https://git-wip-us.apache.org/repos/asf?p=qpid-dispatch.git;h=da6688a ]

DISPATCH-399: Fix out-dated console docs in asciidoc conversion.

The console chapter of the user guide was converted to asciidoc from out-of-date
documentaiton, this has been corrected.


> Convert documentation to asciidoc format
> 
>
> Key: DISPATCH-399
> URL: https://issues.apache.org/jira/browse/DISPATCH-399
> Project: Qpid Dispatch
>  Issue Type: Improvement
>  Components: Documentation
>Affects Versions: 0.6.0
>Reporter: Alan Conway
>Assignee: Alan Conway
>Priority: Minor
> Fix For: 0.7.0
>
>
> asciidoc format is becoming more popular for documentation and has several 
> advantages over RST + sphinx.
> - Mature, widely-used DocBook model without painful XML syntax
> - Multi-file documents and entity substitution are standard in asciidoc
>   (Sphinx has non-standard extensions, but not defined by RST)
> - simpler, more flexible tools, fewer generation steps.



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)

-
To unsubscribe, e-mail: dev-unsubscr...@qpid.apache.org
For additional commands, e-mail: dev-h...@qpid.apache.org



[jira] [Commented] (DISPATCH-399) Convert documentation to asciidoc format

2016-06-23 Thread Alan Conway (JIRA)

[ 
https://issues.apache.org/jira/browse/DISPATCH-399?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=15346751#comment-15346751
 ] 

Alan Conway commented on DISPATCH-399:
--

Updated the website generation scripts and the "work-in-progress" page on the 
site at http://qpid.apache.org/releases/qpid-dispatch-master/index.html

> Convert documentation to asciidoc format
> 
>
> Key: DISPATCH-399
> URL: https://issues.apache.org/jira/browse/DISPATCH-399
> Project: Qpid Dispatch
>  Issue Type: Improvement
>  Components: Documentation
>Affects Versions: 0.6.0
>Reporter: Alan Conway
>Assignee: Alan Conway
>Priority: Minor
>
> asciidoc format is becoming more popular for documentation and has several 
> advantages over RST + sphinx.
> - Mature, widely-used DocBook model without painful XML syntax
> - Multi-file documents and entity substitution are standard in asciidoc
>   (Sphinx has non-standard extensions, but not defined by RST)
> - simpler, more flexible tools, fewer generation steps.



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)

-
To unsubscribe, e-mail: dev-unsubscr...@qpid.apache.org
For additional commands, e-mail: dev-h...@qpid.apache.org



[jira] [Commented] (DISPATCH-399) Convert documentation to asciidoc format

2016-06-23 Thread ASF subversion and git services (JIRA)

[ 
https://issues.apache.org/jira/browse/DISPATCH-399?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=15346707#comment-15346707
 ] 

ASF subversion and git services commented on DISPATCH-399:
--

Commit 4ba68bb80951f0da70b7584a87fbf1f35ebf0880 in qpid-dispatch's branch 
refs/heads/master from [~aconway]
[ https://git-wip-us.apache.org/repos/asf?p=qpid-dispatch.git;h=4ba68bb ]

DISPATCH-399: Converted documentation to asciidoc format.

Converted .rst documentation files to asciidoc .adoc format.

asciidoc format is becoming more popular for documentation and has several
advantages over RST + sphinx.

- Mature, widely-used DocBook model without painful XML syntax
- Popular with doc writers (coming from docbook) and developers (e.g. github 
support)
- Fully-featured for serious documentation without needing extensions, unlike 
markdown.
- Standard support for multi-file documents and entity substitution
  - Sphinx has non-standard extensions for this, but they are not part of RST.
- Tools are simpler to use, need less configuration than sphinx.

Conversion from RST to asciidoc was straightforward (used pandoc). Most of the
work was tweaking the doc generators and CMake.


> Convert documentation to asciidoc format
> 
>
> Key: DISPATCH-399
> URL: https://issues.apache.org/jira/browse/DISPATCH-399
> Project: Qpid Dispatch
>  Issue Type: Improvement
>  Components: Documentation
>Affects Versions: 0.6.0
>Reporter: Alan Conway
>Assignee: Alan Conway
>Priority: Minor
>
> asciidoc format is becoming more popular for documentation and has several 
> advantages over RST + sphinx.
> - Mature, widely-used DocBook model without painful XML syntax
> - Multi-file documents and entity substitution are standard in asciidoc
>   (Sphinx has non-standard extensions, but not defined by RST)
> - simpler, more flexible tools, fewer generation steps.



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)

-
To unsubscribe, e-mail: dev-unsubscr...@qpid.apache.org
For additional commands, e-mail: dev-h...@qpid.apache.org



[jira] [Commented] (DISPATCH-399) Convert documentation to asciidoc format

2016-06-23 Thread ASF subversion and git services (JIRA)

[ 
https://issues.apache.org/jira/browse/DISPATCH-399?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=15346614#comment-15346614
 ] 

ASF subversion and git services commented on DISPATCH-399:
--

Commit 3f7aa499633e4b4e8e34eaa63f54672060113ea8 in qpid-dispatch's branch 
refs/heads/master from [~aconway]
[ https://git-wip-us.apache.org/repos/asf?p=qpid-dispatch.git;h=3f7aa49 ]

DISPATCH-399: Converted documentation to asciidoc format.

Converted .rst documentation files to asciidoc .adoc format.

asciidoc format is becoming more popular for documentation and has several
advantages over RST + sphinx.

- Mature, widely-used DocBook model without painful XML syntax
- Popular with doc writers (coming from docbook) and developers (e.g. github 
support)
- Fully-featured for serious documentation without needing extensions, unlike 
markdown.
- Standard support for multi-file documents and entity substitution
  - Sphinx has non-standard extensions for this, but they are not part of RST.
- Tools are simpler to use, need less configuration than sphinx.

Conversion from RST to asciidoc was straightforward (used pandoc). Most of the
work was tweaking the doc generators and CMake.


> Convert documentation to asciidoc format
> 
>
> Key: DISPATCH-399
> URL: https://issues.apache.org/jira/browse/DISPATCH-399
> Project: Qpid Dispatch
>  Issue Type: Improvement
>  Components: Documentation
>Affects Versions: 0.6.0
>Reporter: Alan Conway
>Assignee: Alan Conway
>Priority: Minor
>
> asciidoc format is becoming more popular for documentation and has several 
> advantages over RST + sphinx.
> - Mature, widely-used DocBook model without painful XML syntax
> - Multi-file documents and entity substitution are standard in asciidoc
>   (Sphinx has non-standard extensions, but not defined by RST)
> - simpler, more flexible tools, fewer generation steps.



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)

-
To unsubscribe, e-mail: dev-unsubscr...@qpid.apache.org
For additional commands, e-mail: dev-h...@qpid.apache.org



[jira] [Commented] (DISPATCH-399) Convert documentation to asciidoc format

2016-06-23 Thread ASF subversion and git services (JIRA)

[ 
https://issues.apache.org/jira/browse/DISPATCH-399?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=15346601#comment-15346601
 ] 

ASF subversion and git services commented on DISPATCH-399:
--

Commit 9504f42b26c0020bef4d387c98ff850e144795f2 in qpid-dispatch's branch 
refs/heads/master from [~aconway]
[ https://git-wip-us.apache.org/repos/asf?p=qpid-dispatch.git;h=9504f42 ]

DISPATCH-399: Converted documentation to asciidoc format.

Converted .rst documentation files to asciidoc .adoc format.

asciidoc format is becoming more popular for documentation and has several
advantages over RST + sphinx.

- Mature, widely-used DocBook model without painful XML syntax
- Popular with doc writers (coming from docbook) and developers (e.g. github 
support)
- Fully-featured for serious documentation without needing extensions, unlike 
markdown.
- Standard support for multi-file documents and entity substitution
  - Sphinx has non-standard extensions for this, but they are not part of RST.
- Tools are simpler to use, need less configuration than sphinx.

Conversion from RST to asciidoc was straightforward (used pandoc). Most of the
work was tweaking the doc generators and CMake.


> Convert documentation to asciidoc format
> 
>
> Key: DISPATCH-399
> URL: https://issues.apache.org/jira/browse/DISPATCH-399
> Project: Qpid Dispatch
>  Issue Type: Improvement
>  Components: Documentation
>Affects Versions: 0.6.0
>Reporter: Alan Conway
>Assignee: Alan Conway
>Priority: Minor
>
> asciidoc format is becoming more popular for documentation and has several 
> advantages over RST + sphinx.
> - Mature, widely-used DocBook model without painful XML syntax
> - Multi-file documents and entity substitution are standard in asciidoc
>   (Sphinx has non-standard extensions, but not defined by RST)
> - simpler, more flexible tools, fewer generation steps.



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)

-
To unsubscribe, e-mail: dev-unsubscr...@qpid.apache.org
For additional commands, e-mail: dev-h...@qpid.apache.org



[jira] [Commented] (DISPATCH-399) Convert documentation to asciidoc format

2016-06-22 Thread Alan Conway (JIRA)

[ 
https://issues.apache.org/jira/browse/DISPATCH-399?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=15344615#comment-15344615
 ] 

Alan Conway commented on DISPATCH-399:
--

Review at https://reviews.apache.org/r/49031/

> Convert documentation to asciidoc format
> 
>
> Key: DISPATCH-399
> URL: https://issues.apache.org/jira/browse/DISPATCH-399
> Project: Qpid Dispatch
>  Issue Type: Improvement
>  Components: Documentation
>Affects Versions: 0.6.0
>Reporter: Alan Conway
>Assignee: Alan Conway
>Priority: Minor
>
> asciidoc format is becoming more popular for documentation and has several 
> advantages over RST + sphinx.
> - Mature, widely-used DocBook model without painful XML syntax
> - Multi-file documents and entity substitution are standard in asciidoc
>   (Sphinx has non-standard extensions, but not defined by RST)
> - simpler, more flexible tools, fewer generation steps.



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)

-
To unsubscribe, e-mail: dev-unsubscr...@qpid.apache.org
For additional commands, e-mail: dev-h...@qpid.apache.org