Some of the formatting problems in the currently published doc are due to using styles in codeblocks. A WYSIWYG view of tables is needed to efficiently maintain the docs. We don't build the DITA docs locally, so it seems impossible to maintain tables that use styles. How about removing angle bracket codes that I suggested and just using names that are obviously variables, like myserver?
On Thu, Mar 19, 2020 at 2:40 AM Tamas Mate (Code Review) < [email protected]> wrote: > Tamas Mate *posted comments* on this change. > > View Change <http://gerrit.cloudera.org:8080/15476> > > Patch set 4: > > Thanks for adding me, it is looks better now. Noticed a style change and 2 > tables left where the formatting is not correct at the moment, these are > related with the style change. > > I can see that <varname> was replaced with '<' and '>' in some > places. In general <varname> is used to describe variables in Impala > documentation, although there are few cases where there are '<' and > '>'. I think we should go with the <varname> tags. > > These are the two commands that I used to check which annotation is used > to mark variables, should be executed in this directory: > 'Impala/docs/topics' > grep -n "<.*>" ./* > grep -n "<varname>.*</varname>" ./* > > (2 comments) > > - > > File docs/topics/impala_show.xml: > <http://gerrit.cloudera.org:8080/#/c/15476/4/docs/topics/impala_show.xml> > - > > Patch Set #4, Line 292: > > <http://gerrit.cloudera.org:8080/#/c/15476/4/docs/topics/impala_show.xml@292> > ------------------- > > The <varname> tags are translated to italic, therefore the extra > dashes are not needed on this table. > - > > Patch Set #4, Line 831: > > <http://gerrit.cloudera.org:8080/#/c/15476/4/docs/topics/impala_show.xml@831> > ------ > > Because the < and > are displayed as < and > in the browser, > this header should be 6 dashes shorter. > > To view, visit change 15476 <http://gerrit.cloudera.org:8080/15476>. To > unsubscribe, visit settings <http://gerrit.cloudera.org:8080/settings>. > Gerrit-Project: Impala-ASF > Gerrit-Branch: master > Gerrit-MessageType: comment > Gerrit-Change-Id: I83fd30b87730c82c87f6f7aee26d8cceb77b6308 > Gerrit-Change-Number: 15476 > Gerrit-PatchSet: 4 > Gerrit-Owner: Kristine Hahn <[email protected]> > Gerrit-Reviewer: Impala Public Jenkins <[email protected]> > > Gerrit-Reviewer: Tamas Mate <[email protected]> > Gerrit-Reviewer: Tim Armstrong <[email protected]> > Gerrit-Comment-Date: Thu, 19 Mar 2020 09:40:27 +0000 > Gerrit-HasComments: Yes > -- Kris Hahn 415-497-8107
