You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@qpid.apache.org by "ASF GitHub Bot (Jira)" <ji...@apache.org> on 2021/09/03 10:45:00 UTC
[jira] [Commented] (DISPATCH-840) "schema.adoc" contains invalid
asciidoc
[ https://issues.apache.org/jira/browse/DISPATCH-840?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17409432#comment-17409432 ]
ASF GitHub Bot commented on DISPATCH-840:
-----------------------------------------
jiridanek commented on pull request #1357:
URL: https://github.com/apache/qpid-dispatch/pull/1357#issuecomment-912443876
`${user}` is not entity name, it is, ... something else; part of the string which has special interpretation
I think I'm only going to fix the doc rendering error in this way, and I will leave formatting changes to people who edit with the docs more and have good overview of the thing in its entirety. Thanks for checking the PR!
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: dev-unsubscribe@qpid.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
> "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-unsubscribe@qpid.apache.org
For additional commands, e-mail: dev-help@qpid.apache.org