[
https://issues.apache.org/jira/browse/DISPATCH-840?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17409435#comment-17409435
]
ASF subversion and git services commented on DISPATCH-840:
----------------------------------------------------------
Commit f5ef65f2587ba93e6dd50f1791c321f74dbe99b2 in qpid-dispatch's branch
refs/heads/main from Jiri Daněk
[ https://gitbox.apache.org/repos/asf?p=qpid-dispatch.git;h=f5ef65f ]
DISPATCH-840 Properly escape the token `${user}` in asciidoc (#1357)
> "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
> Assignee: Jiri Daněk
> Priority: Major
> Fix For: 1.18.0
>
> 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: dev-unsubscr...@qpid.apache.org
For additional commands, e-mail: dev-h...@qpid.apache.org
