[
https://issues.apache.org/jira/browse/DISPATCH-840?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17406035#comment-17406035
]
Jiri Daněk edited comment on DISPATCH-840 at 8/27/21, 9:15 PM:
---------------------------------------------------------------
The problem seems to be the {{You can use the substitution token '${user}' to
specify}} part of the text. If I escape the opening brace, as in {{You can use
the substitution token '$\\{user}' to specify}} then all renders just fine, as
far as I can tell.
was (Author: jdanek):
The problem seems to be the {{You can use the substitution token '${user}' to
specify}} part of the text. If I escape the opening brace, as in {{You can use
the substitution token '$\{user}' to specify}} then all renders just fine, as
far as I can tell.
> "schema.adoc" contains invalid asciidoc
> ---------------------------------------
>
> Key: DISPATCH-840
> URL: https://issues.apache.org/jira/browse/DISPATCH-840
> Project: Qpid Dispatch
> Issue Type: Bug
> Components: Documentation
> Affects Versions: 0.8.0
> Reporter: Ben Hardesty
> Priority: Major
> Fix For: Backlog
>
> Attachments: qdrouterd.conf.html.png
>
>
> The schema_txt.py program [1] generates schema.adoc, which is included in the
> Dispatch Router book [2]. However, there is an issue with the asciidoc that's
> generated: the attributes for each configuration and management entity are
> generated as asciidoc def lists. This is perfectly fine, but some of the
> attributes don't have descriptions. When one of these "empty" def list
> entries immediately precedes a new section, that section is not styled
> properly in the output. To see examples of this, in the Dispatch Router book,
> search for the following strings:
> * {{=== vhost}}
> * {{=== vhostStats}}
> * {{== Management Operations}}
> To fix this issue, in qdrouter.json, a {{"description": "<value>"}}
> name-value pair should be added to each attribute that's missing one. If
> that's not feasible, an alternative would be to update schema_doc.py to
> properly handle any attribute that doesn't have a description (it looks like
> lines 70-71 should handle this, but my python's not up to snuff enough to
> figure out why it isn't).
> [1] -
> https://github.com/apache/qpid-dispatch/blob/master/doc/book/schema_txt.py
> [2] -
> https://qpid.apache.org/releases/qpid-dispatch-0.8.0/book/book.html#_configuration_entities
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
